-
响应参数 状态码:201 表4 响应Body参数 参数 参数类型 描述 payload payloadWithAmountNumber object 实际返回信息 meta_info RespMetaInfo object 元数据 表5 payloadWithAmountNumber 参数 参数类型 描述 item Long 成功数量 表6 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用
IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) Content-Type 是 String 内容类型。填multipart/form-data 表3 FormData参数 参数 是否必选 参数类型 描述 tags 是 File 标签导入文件,json格式,内容可参考请求示例 workspace_id 是 String 工作空间id
-
请求示例 批量添加标签,标签键值对为key1和value1,key2和value3。 {
"action": "create",
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value3"
}
]
}
-
请求示例 批量删除标签key1和key2。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/tags/action
{
"action": "delete",
"tags": [{
"key": "key1"
}, {
"key": "key2",
"value": "value2"
}]
}
-
请求消息 表2 参数说明 名称 是否必选 参数类型 说明 action 是 String 参数解释: 操作标识。 约束限制: 不涉及。 取值范围: 区分大小写,删除时为“delete”。 默认取值: 不涉及。 tags 是 Array of objects 参数解释: 标签列表。 详情请参见表3。 约束限制: 不涉及。 表3 tags字段数据结构说明 名称 是否必选 参数类型 说明 key 是 String 参数解释: 标签键。 约束限制: 不涉及。 取值范围: 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 默认取值: 不涉及。 value 否 String 参数解释: 标签值。 约束限制: 不涉及。 取值范围: 最大长度255个unicode字符,可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@。 默认取值: 不涉及。
-
URI URI格式 POST /v3/{project_id}/instances/{instance_id}/tags/action 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
-
响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 tags Array of objects 参数解释: 标签列表,没有标签默认为空数组。 详情请参见表3。 表3 tags字段数据结构说明 名称 参数类型 说明 key String 参数解释: 标签键。 取值范围: 不涉及。 value String 参数解释: 标签值。 取值范围: 不涉及。 tag_type String 参数解释: 标签类型。 取值范围: 枚举类型:user、system 正常响应样例 {
"tags": [{
"key": "keyName",
"value": "keyValue",
"tag_type": "user"
}]
} 异常响应 请参见异常请求结果。
-
URI URI格式 GET /v3/{project_id}/instances/{instance_id}/tags 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
-
URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 instance_id 是 实例ID。
-
响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 租户标签列表 表4 Tag 参数 参数类型 描述 key String 键;最大长度128个unicode字符。key不能为空。 values Array of strings 值列表;每个值最大长度255个unicode字符。如果values为空列表,则表示查询任意value 状态码:404 表5 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 error_msg String 请求异常信息 request_id String 请求ID
-
标签的使用约束 每个标签由“标签键”和“标签值”组成,“标签键”和“标签值”的命名规则如下: “标签键”: 不能为空。 长度为1~128个字符。 由英文字母、数字、下划线、中划线、UNICODE字符(\u4E00-\u9FFF)组成。 “标签值”: 可以为空。 长度为1~225个字符。 由英文字母、数字、下划线、点、中划线、UNICODE字符(\u4E00-\u9FFF)组成。 每个云资源最多可以添加20个标签。 对于每个云资源,每个“标签键”都必须是唯一的,每个“标签键”只能有一个“标签值”。 本章将为您介绍如下内容: 添加标签,为已有的OU、账号、SCP和标签策略添加标签。 修改标签,修改OU、账号、SCP和标签策略的标签键值。 查看标签,查看OU、账号、SCP和标签策略的标签。 删除标签,删除OU、账号、SCP和标签策略的标签。
-
标签简介 标签用于标识云资源,可通过标签实现对云资源的分类和搜索。您可以向以下组织资源添加标签: 组织的根 组织单元(Organizational Unit,以下简称OU) 账号 服务控制策略(Service Control Policy,以下简称SCP) 标签策略 您可以在以下时间添加标签: 在创建OU、账号、SCP和标签策略时,可以添加标签。 根、OU、账号、SCP和标签策略创建完成后,可以在各自的详情页面添加、修改、查看、删除标签。
-
响应示例 状态码:200 正常返回。 {
"desc" : "success"
} 状态码:401 认证失败。 {
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
} 状态码:403 禁止访问。 {
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
} 状态码:500 请求未完成,服务器内部异常。 {
"error_code" : "SCM.XXX",
"error_msg" : "XXX"
}
-
响应参数 状态码:200 表5 响应Body参数 参数 参数类型 描述 desc String 请求结果。 最小长度:0 最大长度:63 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码:403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码:500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 标签操作标识。 create:创建。 delete:删除。 最小长度:6 最大长度:6 tags 否 Array of ScsResourceTag objects 标签列表,key和value键值对的集合。 数组长度:1 - 20 表4 ScsResourceTag 参数 是否必选 参数类型 描述 key 否 String 标签键。 最小长度:0 最大长度:128 value 否 String 标签值。 最小长度:0 最大长度:255