获取标签列表 - ListOpsLabels
功能介绍
该接口用于获取系统中所有标签的信息列表,支持分页查询和类型筛选,适用于标签管理和选择查询的场景。
适用场景:
URI
GET /v1/ops/labels
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 参数解释: 分页查询的起始偏移量。用于指定从满足条件的第几条记录开始返回,常与 limit参数配合实现分页功能。 约束限制: 必须为整数,且大小在0到10,000 之间。 取值范围: 0-10000。 默认取值: 0。 |
| limit | 否 | Integer | 参数解释: 单次查询返回的最大记录数量。用于控制分页查询时每页显示的数据条数。 约束限制: 必须为整数,且大小在1到100之间。 取值范围: 1-100。 默认取值: 10。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体编码格式。用于告知服务端请求体(Body)所采用的主体数据类型,以便服务端正确解析。 约束限制: 不涉及 取值范围: application/json 默认取值: application/json |
| Authorization | 是 | String | 参数解释: 签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| X-Sdk-Date | 是 | String | 参数解释: 请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释: 满足查询条件的标签总数量。 取值范围: 0到1000000。 |
| labels | Array of OpsLabelItem objects | 参数解释: 当前页展示的标签详细信息列表。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| label_id | String | 参数解释: 标注的唯一标识符(ID)。 取值范围: 不涉及。 |
| creator_id | String | 参数解释: 创建该标注的用户唯一ID。 取值范围: 不涉及。 |
| creator | String | 参数解释: 创建者的名称或账号信息。 取值范围: 不涉及。 |
| name | String | 参数解释: 标注的显示名称。 取值范围: 不涉及。 |
| content_type | String | 参数解释: 标注的内容类型(如分类category 等)。 取值范围: 不涉及。 |
| description | String | 参数解释: 关于该标注的详细说明或补充信息。 取值范围: 不涉及。 |
| enums | Array of OpsLabelValueItem objects | 参数解释: 该标注包含的枚举值(选项)列表。 取值范围: 不涉及。 |
请求示例
请求获取标签的信息列表
GET https://*.com/agentarts/v1/ops/labels
响应示例
状态码:200
返回标签列表
{
"total_count" : 25,
"labels" : [ {
"label_id" : "bff361a2-8b57-46cc-8259-faba0dae34e4",
"creator_id" : "b691749589164e26a276ad287100cc79",
"creator" : "creator",
"name" : "name",
"content_type" : "category",
"description" : "",
"enums" : [ {
"id" : "bff361a2-8b57-46cc-8259-faba0dae34e4",
"display_name" : "test"
} ]
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 返回标签列表 |
错误码
请参见错误码。