
# 获取标签列表 - ListOpsLabels
#### 功能介绍
该接口用于获取系统中所有标签的信息列表，支持分页查询和类型筛选，适用于标签管理和选择查询的场景。
适用场景：
- 查看系统中可用的所有标签资源。
  
- 在评估任务中选择合适的标签进行分类。
  
- 看标签的详细信息，维护标签体系的完整性。
  
 
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-agentarts/agentarts_07_0003.html)。
#### 授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-agentarts/Permission.html)。
| 授权项                      | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| agentarts::listOpsLabels | List | -           | -   | -  | -      |
   
#### URI
GET /v1/ops/labels
表1Query参数 
| 参数           | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| name         | 否    | String  | **参数解释：** 标签名称过滤条件。用于根据标签名称进行模糊或精确匹配查询。 **约束限制：** 不涉及。 **取值范围：** 由中文字符、英文字母、数字及常用符号组成的字符串，长度为0\~100个字符。 **默认取值：** 不涉及。                                                                                                                                                                                                                                                          |
| content_type | 否    | String  | **参数解释：** 标签内容类型过滤条件。用于筛选特定类型的标签资源。 **约束限制：** 不涉及。 **取值范围：** 由英文字母、数字及下划线组成的字符串，长度为0\~50个字符。 **默认取值：** 不涉及。                                                                                                                                                                                                                                                                     |
| exact        | 否    | Boolean | **参数解释：** 精确匹配开关。控制name参数的匹配模式。 **约束限制：** 不涉及。 **取值范围：** - true：精确匹配，name参数必须完全匹配标签名称   - false：模糊匹配，name参数支持部分匹配    **默认取值：** false。 |
| offset       | 否    | Integer | **参数解释：** 分页查询的起始偏移量。用于指定从满足条件的第几条记录开始返回，常与 limit参数配合实现分页功能。 **约束限制：** 必须为整数，且大小在0到10,000之间。 **取值范围：** 0-10000。 **默认取值：** 0。                                                                                                                                                                                                                                                    |
| limit        | 否    | Integer | **参数解释：** 单次查询返回的最大记录数量。用于控制分页查询时每页显示的数据条数。 **约束限制：** 必须为整数，且大小在1到100之间。 **取值范围：** 1-100。 **默认取值：** 10。                                                                                                                                                                                                                                                                         |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表2响应Body参数 
| 参数          | 参数类型                                                                   | 描述                                                                                                                                        |
|:---|:---|:---|
| total_count | Integer                                                                | **参数解释：** 满足查询条件的标签总数量。 **取值范围：** 不涉及。 |
| labels      | Array of [OpsLabelItem] objects | **参数解释：** 当前页展示的标签详细信息列表。数组内每个元素为OpsLabelItem对象，包含标签ID、创建者、名称、内容类型、描述及枚举值等信息。                            |
   
 表3OpsLabelItem 
| 参数           | 参数类型                                                                             | 描述                                                                                                                                                  |
|:---|:---|:---|
| label_id     | String                                                                           | **参数解释：** 标注的唯一标识符（ID）。 **取值范围：** 不涉及。           |
| creator_id   | String                                                                           | **参数解释：** 创建该标注的用户唯一ID。 **取值范围：** 不涉及。           |
| creator      | String                                                                           | **参数解释：** 创建者的名称或账号信息。 **取值范围：** 不涉及。            |
| name         | String                                                                           | **参数解释：** 标注的显示名称。 **取值范围：** 不涉及。                |
| content_type | String                                                                           | **参数解释：** 标注的内容类型（如分类category 等）。 **取值范围：** 不涉及。 |
| description  | String                                                                           | **参数解释：** 关于该标注的详细说明或补充信息。 **取值范围：** 不涉及。        |
| enums        | Array of [OpsLabelValueItem] objects | **参数解释：** 该标注包含的枚举值（选项）列表。数组内每个元素为OpsLabelValueItem对象，包含标签值ID和展示名称等信息。                                             |
   
 表4OpsLabelValueItem 
| 参数           | 参数类型   | 描述                                                                                                                                                                                                                                   |
|:---|:---|:---|
| id           | String | **参数解释：** 标签值的唯一标识符（ID）。 **取值范围：** 不涉及。 **获取方式：** 通过查询标签列表接口获取。 |
| display_name | String | **参数解释：** 标签面向用户展示的名称。 **取值范围：** 不涉及。                                                                                             |
   
#### 请求示例
请求获取标签的信息列表
```
GET https://api.example.com/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 | 返回标签列表 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-agentarts/ErrorCode.html)。
