Help Center/ Identity and Access Management_Identity and Access Management (New Edition)/ API Reference/ API/ IAM/ Managing Resource Tags/ Adding Tags to IAM Resources
Updated on 2025-11-06 GMT+08:00
View PDF
Share

Adding Tags to IAM Resources

Function

This API is used to add tags to IAM resources.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

iam::tagForResourceV5

Tagging

agency

g:ResourceTag/<tag-key>

-

-

user

g:ResourceTag/<tag-key>

-

  • g:RequestTag/<tag-key>

  • g:TagKeys

URI

POST /v5/{resource_type}/{resource_id}/tags/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

resource_id

Yes

String

Resource ID. The value contains 1 to 64 characters, including only letters, digits, and hyphens (-).

resource_type

Yes

String

Resource type. The value can be trust agency or user.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

tags

No

Array of Tag objects

List of custom tags.

Array Length: 1 - 20
Table 3 Tag

Parameter

Mandatory

Type

Description

tag_key

Yes

String

Tag key. The value can contain 1 to 64 characters. Letters, digits, spaces, and the following special characters are allowed: _.:=+-@. The key cannot start with a space or _sys_ or end with a space.

Minimum: 1

Maximum: 64

tag_value

Yes

String

Tag value. The value can be an empty string or contain 0 to 128 characters. Letters, digits, spaces, and the following special characters are allowed: _.:/=+-@

Minimum: 0

Maximum: 128

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

tags

Array of Tag objects

List of custom tags.
Table 5 Tag

Parameter

Type

Description

tag_key

String

Tag key. The value can contain 1 to 64 characters. Letters, digits, spaces, and the following special characters are allowed: _.:=+-@. The key cannot start with a space or _sys_ or end with a space.

Minimum: 1

Maximum: 64

tag_value

String

Tag value. The value can be an empty string or contain 0 to 128 characters. Letters, digits, spaces, and the following special characters are allowed: _.:/=+-@

Minimum: 0

Maximum: 128

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Request ID.

encoded_authorization_message

String

Encrypted authentication failure information, which can be decrypted using the STS5 decryption API.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Request ID.

Status code: 409

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Request ID.

Example Requests

Adding a tag to a specified IAM resource, with tag key key and tag value value

POST https://{endpoint}/v5/{resource_type}/{resource_id}/tags/create

{
  "tags" : [ {
    "tag_key" : "key",
    "tag_value" : "value"
  } ]
}

Example Responses

Status code: 200

Successful

{
  "tags" : [ {
    "tag_key" : "key",
    "tag_value" : "value"
  } ]
}

Status Codes

Status Code

Description

200

Successful

400

Bad request

403

Forbidden

404

Not found

409

Conflict

Error Codes

See Error Codes.

Parent topic: Managing Resource Tags