更新时间:2026-04-15 GMT+08:00
分享

获取标签详情 - ShowOpsLabel

功能介绍

该接口用于获取标签的详细信息,包括标签名称、类型、描述和关联的标注项,适用于标签详情查看和标签管理的场景。

适用场景:

  • 查看标签的完整配置信息和关联内容。

  • 审核和验证标签的使用范围和限制。

  • 标签系统维护和数据质量检查。

URI

GET /v1/ops/labels/{label_id}

表1 路径参数

参数

是否必选

参数类型

描述

label_id

String

参数解释:

标签的唯一标识符(ID)。该参数用于在路径中指定目标标签,以便对其进行属性修改、删除或添加自定义标签值等操作。获取方法请参见5.2-获取标签列表 - ListOpsLabels。

约束限制:

字符串长度为0到100。

取值范围:

0-100字符。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体编码格式。用于告知服务端请求体(Body)所采用的主体数据类型,以便服务端正确解析。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json

Authorization

String

参数解释:

签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

X-Sdk-Date

String

参数解释:

请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释:

满足查询条件的标签总数量。

取值范围:

0到1000000。

labels

Array of OpsLabelItem objects

参数解释:

当前页展示的标签详细信息列表。

取值范围:

不涉及。

表4 OpsLabelItem

参数

参数类型

描述

label_id

String

参数解释:

标注的唯一标识符(ID)。

取值范围:

不涉及。

creator_id

String

参数解释:

创建该标注的用户唯一ID。

取值范围:

不涉及。

creator

String

参数解释:

创建者的名称或账号信息。

取值范围:

不涉及。

name

String

参数解释:

标注的显示名称。

取值范围:

不涉及。

content_type

String

参数解释:

标注的内容类型(如分类category 等)。

取值范围:

不涉及。

description

String

参数解释:

关于该标注的详细说明或补充信息。

取值范围:

不涉及。

enums

Array of OpsLabelValueItem objects

参数解释:

该标注包含的枚举值(选项)列表。

取值范围:

不涉及。

表5 OpsLabelValueItem

参数

参数类型

描述

id

String

参数解释:

标签值的唯一标识符(ID)。

取值范围:

不涉及。

display_name

String

参数解释:

标签面向用户展示的名称。

取值范围:

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

系统定义的标准化错误代码。

取值范围:

业务异常编码字符串。

error_msg

String

参数解释:

对错误的详细描述,包含异常原因或解决建议。

取值范围:

任意文本内容。

请求示例

请求获取标签的详细信息

GET https://*.com/agentarts/v1/ops/labels/a67452bf21f819-6f91-4568-9f2f-57ef9562ab7

响应示例

状态码: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"
    } ]
  } ]
}

状态码:400

错误请求

{
  "error_code" : "AgentArts.03400001",
  "error_msg" : "请求错误"
}

状态码

状态码

描述

200

返回查看标签详情

400

错误请求

错误码

请参见错误码

相关文档