创建标签 - CreateOpsLabel
功能介绍
该接口用于创建新标签,支持文本标签和布尔类型的自定义标签,适用于资源分类、数据标注和标签管理的场景。
适用场景:
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| agentarts::createOpsLabel | Write | - | - | - | - |
URI
POST /v1/ops/labels
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 待创建的标签名称。 约束限制: 不涉及。 取值范围: 只能由中文字符、英文字母、数字及「_」、「-」、「.」组成,长度为0~100个字符。 默认取值: 不涉及。 |
| type | 是 | String | 参数解释: 标签的类型(如 free-text 等),用于定义标签的交互或存储逻辑。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| description | 否 | String | 参数解释: 对该标签用途或含义的详细描述。 约束限制: 不涉及。 取值范围: 只能由中文字符、英文字母、数字及「_」、「-」、「.」组成,长度为0~400个字符。 默认取值: 不涉及。 |
| enums | 是 | Array of OpsLabelValueItem objects | 参数解释: 标签的可选值(枚举)列表,定义该标签下包含的具体标记项。数组内每个元素为OpsLabelValueItem对象,包含标签值ID和展示名称等信息。数组长度为0~100,不传入时默认为空列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | String | 参数解释: 创建成功的标签唯一标识符(ID)。 取值范围: 只能由英文字母、数字及连字符(-)组成,长度为0~64个字符。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 系统定义的标准化错误代码。 取值范围: 业务异常编码字符串。 |
| error_msg | String | 参数解释: 对错误的详细描述,包含异常原因或解决建议。 取值范围: 字符长度2-512,任意文本内容。 |
| encoded_authorization_message | String | 参数解释: 编码后的授权信息,用于客户端解析权限问题。 取值范围: Base64编码的字符串。 |
| details | Array of OpsErrorDetail objects | 参数解释: 错误详情列表,包含多个子错误的详细信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求的唯一标识符,用于问题排查和链路追踪。 取值范围: 符合通用唯一识别码(UUID)标准的字符串。 |
请求示例
请求创建新标签
POST https://api.example.com/v1/ops/labels
{
"name" : "分类标签",
"type" : "free-text",
"description" : "暂无描述",
"enums" : [ {
"id" : "bff361a2-8b57-46cc-8259-faba0dae34e4",
"display_name" : "test"
} ]
} 响应示例
状态码:200
返回创建标签的信息
{
"data" : "1769499746650415700514"
} 状态码:400
返回错误信息
{
"error_code" : "AgentArts.03400001",
"error_msg" : "Key: 'CreateTagRequest.Type' Error:Field validation for 'Type' failed on the 'oneof' tag"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 返回创建标签的信息 |
| 400 | 返回错误信息 |
错误码
请参见错误码。