获取标签列表 - ListOpsLabels
功能介绍
该接口用于获取系统中所有标签的信息列表,支持分页查询和类型筛选,适用于标签管理和选择查询的场景。
适用场景:
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::listOpsLabels | List | - | - | - | - |
URI
GET /v1/ops/labels
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 标签名称过滤条件。用于根据标签名称进行模糊或精确匹配查询。 约束限制: 不涉及。 取值范围: 由中文字符、英文字母、数字及「_」、「-」、「.」组成,长度为0~100个字符。 默认取值: 不涉及。 |
| content_type | 否 | String | 参数解释: 标签内容类型过滤条件。用于筛选特定类型的标签资源。 约束限制: 不涉及。 取值范围: 由英文字母、数字及下划线组成的字符串,长度为0~50个字符。 默认取值: 不涉及。 |
| exact | 否 | Boolean | 参数解释: 精确匹配开关。控制name参数的匹配模式。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
| offset | 否 | Integer | 参数解释: 分页查询的起始偏移量。用于指定从满足条件的第几条记录开始返回,常与 limit参数配合实现分页功能。 约束限制: 必须为整数,且大小在0到10,000之间。 取值范围: 0-10000。 默认取值: 0。 |
| limit | 否 | Integer | 参数解释: 单次查询返回的最大记录数量。用于控制分页查询时每页显示的数据条数。 约束限制: 必须为整数,且大小在1到100之间。 取值范围: 1-100。 默认取值: 10。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | data object | 参数解释: 响应数据主体。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Long | 参数解释: 满足查询条件的标签总数量。 取值范围: 不涉及。 |
| tags | Array of OpsLabelItem objects | 参数解释: 当前页展示的标签详细信息列表。数组内每个元素为OpsLabelItem对象,包含标签ID、创建者、名称、内容类型、描述及枚举值等信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 标签的唯一标识符(ID)。 取值范围: 不涉及。 |
| account_id | String | 参数解释: 标签所属的租户账号ID。 取值范围: 不涉及。 |
| creator_id | String | 参数解释: 创建该标签的用户唯一ID。 取值范围: 不涉及。 |
| creator | String | 参数解释: 创建者的名称或账号信息。 取值范围: 不涉及。 |
| name | String | 参数解释: 标签的显示名称。 取值范围: 不涉及。 |
| content_type | String | 参数解释: 标签的内容类型(如分类(category)等)。 取值范围: 不涉及。 |
| description | String | 参数解释: 关于该标签的详细说明或补充信息。 取值范围: 不涉及。 |
| enums | Array of OpsLabelValueItem objects | 参数解释: 该标签包含的枚举值(选项)列表。数组内每个元素为OpsLabelValueItem对象,包含标签值ID和展示名称等信息。 |
| status | String | 参数解释: 标签状态。 取值范围: |
| updated_by | String | 参数解释: 最后更新该标签的用户名称。 取值范围: 不涉及。 |
| version | Integer | 参数解释: 标签数据版本号,用于乐观锁控制。 取值范围: 非负整数。 |
| created_at | String | 参数解释: 标签创建时间。 取值范围: ISO 8601 时间格式。 |
| updated_at | String | 参数解释: 标签更新时间。 取值范围: ISO 8601 时间格式。 |
请求示例
请求获取标签的信息列表
GET https://api.example.com/v1/ops/labels
响应示例
状态码:200
{
"data" : {
"total" : 25,
"tags" : [ {
"id" : "bff361a2-8b57-46cc-8259-faba0dae34e4",
"account_id" : "b691749589164e26a276ad287100cc79",
"creator_id" : "b691749589164e26a276ad287100cc79",
"creator" : "creator",
"name" : "name",
"content_type" : "category",
"description" : "",
"status" : "active",
"enums" : [ {
"id" : "bff361a2-8b57-46cc-8259-faba0dae34e4",
"tag_value_name" : "test",
"status" : "active",
"color" : "",
"order" : 0
} ],
"updated_by" : "creator",
"version" : 0,
"created_at" : "2026-04-14T01:22:42.192Z",
"updated_at" : "2026-04-14T01:22:42.192Z"
} ]
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 返回标签列表 |
错误码
请参见错误码。