getCatalogRole
获取一个署名职务
一行署名职务注册表记录。未知 id 为 404 NOT_FOUND。可匿名调用,按 IP 地址限流;应用密钥或带 catalog:read 的用户访问令牌各有更高的额度。
get
/v2/catalog/roles/{id} scope
catalog:read可匿名调用(不带凭据按 IPv4 地址或 IPv6 /64 限流(默认 30 次/分钟、1,000 次/天);带 nmk_ 应用密钥或带 catalog:read 的用户访问令牌则走各自更高的额度)参数
| 参数 | 类型 | 位置 | 说明 |
|---|---|---|---|
id 必填 | string | path | 十进制 catalog id。 |
nsfw | string | query | true 包含 r18。false 或缺省则隐藏 r18。仅 true 或 false。 |
view | string | query | basic(默认)或 full。封闭词表。 |
include | string | query | 逗号分隔的块。未知 token 返回 400 UNKNOWN_INCLUDE。 |
fields | string | query | 逗号分隔的顶层键。未知 token 返回 400 UNKNOWN_FIELD。object 与 id 始终保留。 |
响应
categorystring必填开放的分组词表。未分类则为空。不得用作判别条件。
deprecatedboolean必填注册表已将该职务停用于新署名时为 true。
display_namestring必填不得用作判别条件。
idstring必填catalog 署名职务 id。
keystring必填注册表 token,每职务唯一;与署名组的 role_key 相接。并不总是 ASCII。不得用作判别条件。
localizedmap<string, object>必填BCP-47 键。没有则为空对象。不得用作判别条件。
«key»object
objectstring必填类型判别字段。恒为 role。
枚举role
请求示例
cURL
curl "https://api.nextmoe.dev/v2/catalog/roles/1"