更新标签 - UpdateOpsLabel
功能介绍
该接口用于更新标签信息,支持修改标签名称、描述和标注项,适用于标签内容维护和完善的场景。
适用场景:
URI
PUT /v1/ops/labels/{label_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
label_id |
是 |
String |
参数解释: 需要被更新的标签唯一标识符(ID)。 约束限制: 字符串长度为0到100。 取值范围: 0-100字符。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
参数解释: 消息体编码格式。用于告知服务端请求体(Body)所采用的主体数据类型,以便服务端正确解析。 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json |
|
Authorization |
是 |
String |
参数解释: 签名认证信息,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
X-Sdk-Date |
是 |
String |
参数解释: 请求发送的时间,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释: 更新后的标签名称。 约束限制: 字符串长度为0到100个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
type |
是 |
String |
参数解释: 标签的类型(如 free-text 等)。 约束限制: 字符串长度为0到100个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
description |
否 |
String |
参数解释: 对该标签用途或修改变动的详细说明。 约束限制: 字符串长度为0到400个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
enums |
是 |
Array of OpsLabelValueItem objects |
参数解释: 标签的可选值(枚举)列表。 约束限制: 数组长度为0到100。 取值范围: 不涉及。 默认取值: 空列表。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 标签的唯一标识符(ID)。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 更新后的标签名称。 取值范围: 不涉及。 |
|
type |
String |
参数解释: 标签的类型(如free-text等)。 取值范围: 不涉及。 |
|
description |
String |
参数解释: 标签的详细描述信息。 取值范围: 不涉及。 |
|
enums |
Array of OpsLabelValueItem objects |
参数解释: 更新后的标签可选值(枚举)列表。 取值范围: 不涉及。 |
请求示例
请求更新标签信息
PUT https://*.com/agentarts/v1/ops/labels/a67452bf21f819-6f91-4568-9f2f-57ef9562ab7
{
"name" : "分类标签",
"type" : "free-text",
"description" : "暂无描述",
"enums" : [ {
"id" : "bff361a2-8b57-46cc-8259-faba0dae34e4",
"display_name" : "test"
} ]
}
响应示例
状态码:200
返回更新标签成功
{
"id" : "bff361a2-8b57-46cc-8259-faba0dae34e4",
"name" : "分类标签",
"type" : "free-text",
"description" : "暂无描述",
"enums" : [ {
"id" : "bff361a2-8b57-46cc-8259-faba0dae34e4",
"display_name" : "test"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
返回更新标签成功 |
错误码
请参见错误码。