获取标签详情 - ShowOpsLabel
功能介绍
该接口用于获取标签的详细信息,包括标签名称、类型、描述和关联的标注项,适用于标签详情查看和标签管理的场景。
适用场景:
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::showOpsLabel | Read | - | - | - | - |
URI
GET /v1/ops/labels/{label_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| label_id | 是 | String | 参数解释: 标签的唯一标识符(ID)。可通过调用查询标签列表接口获取。 约束限制: 不涉及。 取值范围: 由字母、数字和连字符(-)组成的字符串,长度为1~100个字符。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | OpsLabelItem object | 参数解释: 响应数据主体,为标签详情对象。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 标签的唯一标识符(ID)。 取值范围: 不涉及。 |
| account_id | String | 参数解释: 标签所属的租户账号ID。 取值范围: 不涉及。 |
| creator_id | String | 参数解释: 创建该标签的用户唯一ID。 取值范围: 不涉及。 |
| creator | String | 参数解释: 创建者的名称或账号信息。 取值范围: 不涉及。 |
| name | String | 参数解释: 标签的显示名称。 取值范围: 不涉及。 |
| content_type | String | 参数解释: 标签的内容类型(如分类(category)等)。 取值范围: 不涉及。 |
| description | String | 参数解释: 关于该标签的详细说明或补充信息。 取值范围: 不涉及。 |
| enums | Array of OpsLabelValueItemResponse objects | 参数解释: 该标签包含的枚举值(选项)列表。数组内每个元素为OpsLabelValueItem对象,包含标签值ID和展示名称等信息。 |
| status | String | 参数解释: 标签状态。 取值范围: |
| updated_by | String | 参数解释: 最后更新该标签的用户名称。 取值范围: 不涉及。 |
| version | Integer | 参数解释: 标签数据版本号,用于乐观锁控制。 取值范围: 非负整数。 |
| created_at | String | 参数解释: 标签创建时间。 取值范围: ISO 8601 时间格式。 |
| updated_at | String | 参数解释: 标签更新时间。 取值范围: ISO 8601 时间格式。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 标签值的唯一标识符(ID)。 取值范围: 不涉及。 |
| tag_value_name | String | 参数解释: 标签面向用户展示的名称。 取值范围: 不涉及。 |
| status | String | 参数解释: 标签项状态。 取值范围: 枚举值: |
| color | String | 参数解释: 标签项展示颜色。 取值范围: HEX格式颜色码,例如#FF0000表示红色。 |
| order | Integer | 参数解释: 标签项排序序号,数值越小展示越靠前(按升序排列)。 取值范围: 0~10000(非负整数)。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
请求示例
请求获取标签的详细信息
GET https://api.example.com/v1/ops/labels/a67452bf21f819-6f91-4568-9f2f-57ef9562ab7
响应示例
状态码:200
{
"data" : {
"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" : "0",
"order" : 0
} ],
"updated_by" : "creator",
"version" : 0,
"created_at" : "2026-04-14T01:22:42.192Z",
"updated_at" : "2026-04-14T01:22:42.192Z"
}
} 状态码:400
{
"error_code" : "AgentArts.03400001",
"error_msg" : "请求错误",
"encoded_authorization_message" : "",
"details" : [ {
"error_code" : "AgentArts.03400001",
"error_msg" : "请求错误"
} ],
"request_id" : "a3f5e2b1-4c6d-4e8f-9a2b-1c3d5e7f9a2b"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 返回查看标签详情 |
| 400 | 请求错误 |
错误码
请参见错误码。