更新时间:2026-09-24 GMT+08:00
分享

更新标签 - UpdateOpsLabel

功能介绍

该接口用于更新标签信息,支持修改标签名称、描述和标注项,适用于标签内容维护和完善的场景。

适用场景:

  • 更新标签的描述信息以反映最新使用场景。

  • 添加或修改标签的支持选项和枚举值。

  • 修正标签配置以适应业务需求变化。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

agentarts::updateOpsLabel

Write

-

-

-

-

URI

PUT /v1/ops/labels/{label_id}

表1 路径参数

参数

是否必选

参数类型

描述

label_id

是

String

参数解释:

需要被更新的标签唯一标识符(ID)。可通过调用查询标签列表接口获取。

约束限制:

不涉及。

取值范围:

由字母、数字和连字符(-)组成的字符串,长度为1~100个字符。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

参数解释:

更新后的标签名称。

约束限制:

不涉及。

取值范围:

由中文字符、英文字母、数字及下划线(_)、连字符(-)、点(.)组成的字符串,长度为0~100个字符。

默认取值:

不涉及。

description

否

String

参数解释:

对该标签用途或修改变动的详细说明。

约束限制:

不涉及。

取值范围:

任意字符串,长度为0~400个字符。

默认取值:

不涉及。

enums

否

Array of OpsLabelValueItem objects

参数解释:

标签的可选值(枚举)列表。数组内每个元素为OpsLabelValueItem对象,包含枚举值的ID和显示名称。

约束限制:

数组元素最小数量为0,最大数量为100。

取值范围:

不涉及。

默认取值:

不涉及。

表3 OpsLabelValueItem

参数

是否必选

参数类型

描述

id

否

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

获取方式:

通过查询标签列表接口获取。

tag_value_name

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

status

否

String

参数解释:

标签项状态。

约束限制:

可选,必须为枚举值之一。

取值范围:

  • ACTIVE:启用

  • INACTIVE:停用

默认取值:

ACTIVE(不传默认为启用)。

color

否

String

参数解释:

标签项展示颜色。

约束限制:

不涉及。

取值范围:

0~1000。

默认取值:

不涉及。

order

否

Integer

参数解释:

标签项排序序号,数值越小展示越靠前(按升序排列)。

约束限制:

可选,非负整数。

取值范围:

0~10000。

默认取值:

0(不传时默认为0,按添加顺序展示)。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释:

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

取值范围:

不涉及。

name

String

参数解释:

更新后的标签名称。

取值范围:

不涉及。

type

String

参数解释:

标签的类型(如free-text等)。

取值范围:

不涉及。

description

String

参数解释:

标签的详细描述信息。

取值范围:

不涉及。

enums

Array of OpsLabelValueItem objects

参数解释:

更新后的标签可选值(枚举)列表。

取值范围:

不涉及。

表5 OpsLabelValueItem

参数

参数类型

描述

id

String

参数解释:

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

取值范围:

不涉及。

获取方式:

通过查询标签列表接口获取。

tag_value_name

String

参数解释:

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

取值范围:

不涉及。

status

String

参数解释:

标签项状态。

取值范围:

  • ACTIVE:启用

  • INACTIVE:停用

color

String

参数解释:

标签项展示颜色。

取值范围:

0~1000。

order

Integer

参数解释:

标签项排序序号,数值越小展示越靠前(按升序排列)。

取值范围:

0~10000。

请求示例

请求更新标签信息

PUT https://api.example.com/v1/ops/labels/a67452bf21f819-6f91-4568-9f2f-57ef9562ab7

{
  "name" : "分类标签",
  "description" : "暂无描述",
  "enums" : [ {
    "id" : "bff361a2-8b57-46cc-8259-faba0dae34e4",
    "tag_value_name" : "test"
  } ]
}

响应示例

状态码:200

{
  "data" : null
}

状态码

状态码

描述

200

返回更新标签成功

错误码

请参见错误码。

相关文档