创建标签 - CreateOpsLabel
功能介绍
该接口用于创建新标签,支持文本标签和布尔类型的自定义标签,适用于资源分类、数据标注和标签管理的场景。
适用场景:
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::createOpsLabel | Write | - | - | - | - |
URI
POST /v1/ops/labels
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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
| 参数 | 参数类型 | 描述 |
|---|---|---|
| label_id | String | 参数解释: 创建成功的标签唯一标识符(ID)。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 任意文本内容。 |
请求示例
请求创建新标签
POST https://*.com/agentarts/v1/ops/labels
{
"name" : "分类标签",
"type" : "free-text",
"description" : "暂无描述",
"enums" : [ {
"id" : "bff361a2-8b57-46cc-8259-faba0dae34e4",
"display_name" : "test"
} ]
} 响应示例
状态码:200
返回创建标签的信息
{
"label_id" : "1769499746650415700514"
} 状态码:400
返回错误信息
{
"error_code" : "AgentArts.03400001",
"error_msg" : "Key: 'CreateTagRequest.Type' Error:Field validation for 'Type' failed on the 'oneof' tag"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 返回创建标签的信息 |
| 400 | 返回错误信息 |
错误码
请参见错误码。