跳到主要内容

完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本;本页的 Markdown 版本可在此获取。

标签

标签相关操作

获取所有标签 ​

获取实例中的所有标签。

GET/tags

请求参数

参数位置类型必填说明
limitquerynumber否

最多返回的数据项数量。

默认值:100

cursorquerystring否

将 cursor 参数设为上次请求响应中的 nextCursor 属性,以进行分页。使用默认值时,获取集合的第一页。更多信息,请参阅分页说明。

响应

状态码说明
200

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

响应结构:200 · application/json
字段类型必填说明
dataarray是
展开字段
字段类型必填说明
data.[]idstring是

只读。

data.[]namestring是
data.[]createdAtstring是

只读。

data.[]updatedAtstring是

只读。

nextCursorstring是

下载完整 OpenAPI 定义(JSON)

创建标签 ​

在实例中创建标签。

POST/tags

请求参数

参数位置类型必填说明
Idempotency-Keyheaderstring否

此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求,会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试,会返回 409。

请求体

application/json

字段类型必填说明
idstring否

只读。

namestring是
createdAtstring否

只读。

updatedAtstring否

只读。

响应

状态码说明
201

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

409

冲突

415

不支持的媒体类型。

422

无法处理的实体

响应结构:201 · application/json
字段类型必填说明
idstring是

只读。

namestring是
createdAtstring是

只读。

updatedAtstring是

只读。

下载完整 OpenAPI 定义(JSON)

获取标签 ​

获取标签。

GET/tags/{tagId}

请求参数

参数位置类型必填说明
tagIdpathstring是

标签的 ID。

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

404

未找到指定资源。

响应结构:200 · application/json
字段类型必填说明
idstring是

只读。

namestring是
createdAtstring是

只读。

updatedAtstring是

只读。

下载完整 OpenAPI 定义(JSON)

更新标签 ​

更新标签。

PUT/tags/{tagId}

请求参数

参数位置类型必填说明
tagIdpathstring是

标签的 ID。

请求体

application/json

字段类型必填说明
idstring否

只读。

namestring是
createdAtstring否

只读。

updatedAtstring否

只读。

响应

状态码说明
200

操作成功。

400

请求无效,或提供的数据格式错误。

401

未授权

403

禁止访问

404

未找到指定资源。

409

冲突

415

不支持的媒体类型。

响应结构:200 · application/json
字段类型必填说明
idstring是

只读。

namestring是
createdAtstring否

只读。

updatedAtstring否

只读。

下载完整 OpenAPI 定义(JSON)

删除标签 ​

删除标签。

DELETE/tags/{tagId}

请求参数

参数位置类型必填说明
tagIdpathstring是

标签的 ID。

响应

状态码说明
200

操作成功。

401

未授权

403

禁止访问

404

未找到指定资源。

响应结构:200 · application/json
字段类型必填说明
idstring是

只读。

namestring是
createdAtstring是

只读。

updatedAtstring是

只读。

下载完整 OpenAPI 定义(JSON)

本文为社区中文翻译。查看对应英文原文