Updated on 2026-10-16 GMT+08:00

Obtaining All Tags of a Specified Resource

Function

This API is used to obtain all tags of a 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
iam::listTagsForResourceV5	List	agency	g:ResourceTag/<tag-key>	-	-
		user	g:ResourceTag/<tag-key> iam:ResourceIsRootUser
		samlProvider	g:ResourceTag/<tag-key>
		oidcProvider	g:ResourceTag/<tag-key>

URI

GET /v5/{resource_type}/{resource_id}/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
resource_id	Yes	String	Definition Resource ID. For details about how to obtain the value, refer to the console page for the corresponding resource type or call the relevant query API. Constraints N/A Range The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value N/A
resource_type	Yes	String	Definition Resource type. Constraints N/A Range Value options: agency, user, saml_provider, oidc_provider, and policy agency: trust agency user: IAM user oidc_provider: OIDC identity provider saml_provider: SAML identity provider policy: IAM identity policy Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
tags	Array of tags objects	Definition List of custom tags. Each tag object contains both tag_key and tag_value. Range N/A

**Table 3** tags
Parameter	Type	Description
tag_key	String	Definition Tag key. Range The value can contain 1 to 128 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.
tag_value	String	Definition Tag value. Range The value can be an empty string or contain 0 to 255 characters. Letters, digits, spaces, and the following special characters are allowed: _.:/=+-@.

Status code: 403

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition: Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A
encoded_authorization_message	String	Definition: Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link. Range: N/A.

Status code: 404

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition: Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A

Example Requests

Obtaining all tags of a specified resource

GET https://{endpoint}/v5/{resource_type}/{resource_id}/tags

Example Responses

Status code: 200

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

Status Codes

Status Code	Description
200	Successful
403	Forbidden
404	Not found

Error Codes

See Error Codes.

Parent topic: Managing Resource Tags