Help Center/ Identity and Access Management_Identity and Access Management (New Edition)/ API Reference/ API/ Access Analyzer/ Tags/ Adding Tags to the Specified Resource
Updated on 2026-07-22 GMT+08:00
View PDF
Share

Adding Tags to the Specified Resource

Function

This API is used to add tags to the specified resource.

Authorization Information

Each account root user 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

AccessAnalyzer::tagResource

Tagging

analyzer *

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_type

Yes

String

Definition:

Resource type.

Range:

  • analyzers: analyzer

resource_id

Yes

String

Definition:

Unique identifier of a resource.

You can call the ListFindings API to retrieve the analysis finding list generated by a specified analyzer. The response of this API contains an analysis result list. Each analysis result object in the list contains information about the analyzed resource. The resource field is the unique identifier (resource ID) of the resource.

Range:

1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of Tag objects

Definition:

List of custom tags.

Constraints:

N/A

Range:

Array length: 1 to 20.

Default Value:

N/A
Table 3 Tag

Parameter

Mandatory

Type

Description

key

Yes

String

Definition:

Tag key.

Constraints:

Cannot start with sys and cannot start or end with a space.

Range:

1 to 128 characters. The value can contain Unicode letters, digits, spaces, and the following special characters: _.:=+-@.

Default Value:

N/A

value

Yes

String

Definition:

String value associated with the tag key.

Constraints:

N/A

Range:

0 to 255 characters. The value can contain Unicode letters, digits, spaces, and the following special characters: _.:/=+-@.

Default Value:

N/A

Response Parameters

Status code: 200

OK

None

Example Requests

Adding a tag to the specified resource

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

{
  "tags" : [ {
    "key" : "key-1",
    "value" : "value-1"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Tags