文档 API v2listCatalogRoles

listCatalogRoles

列出署名职务

keyset 分页的署名职务注册表。全表约 231 行，构建选择器的客户端三页即可取完。key 与署名组的 role_key 相接；ids= 是批量车道，不分页。refs= 不解析：职务没有 catalog_external_ref 实体类型。可匿名调用，按 IP 地址限流；应用密钥或带 catalog:read 的用户访问令牌各有更高的额度。

get/v2/catalog/roles

scope catalog:read可匿名调用（不带凭据按 IPv4 地址或 IPv6 /64 限流（默认 30 次/分钟、1,000 次/天）；带 nmk_ 应用密钥或带 catalog:read 的用户访问令牌则走各自更高的额度）

参数

参数	类型	位置	说明
`cursor`	`string`	`query`	来自先前 next_cursor 的不透明 keyset cursor。必须以 cur_ 开头。
`limit`	`string`	`query`	页大小 1-100，缺省 20。超过 100 为 400 LIMIT_TOO_LARGE，不钳制。
`view`	`string`	`query`	basic（默认）或 full。封闭词表。
`include`	`string`	`query`	逗号分隔的块。未知 token 返回 400 UNKNOWN_INCLUDE。
`fields`	`string`	`query`	view/include 之后逗号分隔的顶层键。未知 token 返回 400 UNKNOWN_FIELD。object 与 id 始终保留。
`ids`	`string`	`query`	逗号分隔的 id，最多 100 个。批量车道：无分页。
`refs`	`string`	`query`	逗号分隔的 source:external_id，最多 100 个。批量车道：无分页。
`include_total`	`string`	`query`	true 则包含 total。仅 true 或 false。
`facets`	`string`	`query`	逗号分隔的 facet 名称。未知 token 返回 400 UNKNOWN_FACET。
`sort`	`string`	`query`	各集合封闭的排序键。
`nsfw`	`string`	`query`	true 包含 r18。false 或缺省则隐藏 r18。仅 true 或 false。

响应

facetsmap<string, object[]>
具名 facet 桶。仅在请求 facets= 时出现。
- «key»object[] 可空
itemsobject[] 必填
本页成员。空数组，从不为 null。
- categorystring 必填
  开放的分组词表。未分类则为空。不得用作判别条件。
- deprecatedboolean 必填
  注册表已将该职务停用于新署名时为 true。
- display_namestring 必填
  不得用作判别条件。
- idstring 必填
  catalog 署名职务 id。
- keystring 必填
  注册表 token，每职务唯一；与署名组的 role_key 相接。并不总是 ASCII。不得用作判别条件。
- localizedmap<string, object> 必填
  BCP-47 键。没有则为空对象。不得用作判别条件。
- objectstring 必填
  类型判别字段。恒为 role。
  枚举role
missingstring[]
已请求但不可见的 ids。仅出现在 ids=/refs= 批量车道。
next_cursorstring
不透明 keyset cursor。末页省略。
objectstring 必填
类型判别字段。恒为 list。
枚举list
totalintegerint64
include_total=true 时出现；页码模式（page=）下恒在。与 items 同一个可见性闸。
total_relationstring
仅在 page 模式出现。eq：total 为精确值。gte：total 为下界。
枚举eqgte

请求示例

cURL

curl "https://api.nextmoe.dev/v2/catalog/roles"