为IAM资源打上标签 - TagResourceV5
功能介绍
该接口可以用于为IAM资源打上标签。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
POST /v5/{resource_type}/{resource_id}/tags/create
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| resource_id | 是 | String | 参数解释: 资源ID。 约束限制: 长度为1到64个字符,只包含字母、数字和"-"的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
| resource_type | 是 | String | 参数解释: 资源类型。 约束限制: 可以为“信任委托”(trust agency)或“IAM用户”(user)。 取值范围: 取值范围为[agency,user]。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| tags | 否 | Array of Tag objects | 参数解释: 自定义标签列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| tag_key | 是 | String | 参数解释: 标签键。 约束限制: 可以包含任意语种字母、数字、空格以及"_"、"."、":"、"="、"+"、"-"、"@"符号的任意组合,但是首尾不能包含空格以及不能使用"_sys_"为开头,长度范围为[1,128]。 取值范围: 不涉及。 默认取值: 不涉及。 |
| tag_value | 是 | String | 参数解释: 标签值。 约束限制: 可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"符号的任意组合,可以是空字符串,长度范围为[0,255]。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| tags | Array of tags objects | 参数解释: 自定义标签列表。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如 PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API 请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误消息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 认证失败时返回的加密详细信息,用于定位认证问题。 可以通过STS5解密接口进行解密,请参见接口链接。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如 PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API 请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
状态码:409
请求示例
为指定IAM资源打上一个标签,标签键为key,标签值为value。
POST https://{endpoint}/v5/{resource_type}/{resource_id}/tags/create
{
"tags" : [ {
"tag_key" : "key",
"tag_value" : "value"
} ]
} 响应示例
状态码:200
请求成功。
{
"tags" : [ {
"tag_key" : "key",
"tag_value" : "value"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 请求体异常。 |
| 403 | 没有操作权限。 |
| 404 | 未找到相应的资源。 |
| 409 | 请求冲突。 |
错误码
请参见错误码。