Use ListTagResources to query resource tags - Resource Access Management - Alibaba Cloud - Resource Access Management

Queries the tags that are added resources.

Operation description

You must specify at least one of the following parameters or parameter pairs in a request to determine a query object:

ResourceId.N
Tag.N.Key
Tag.N.Key and Tag.N.Value

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ram:ListTagResources

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourcePrincipalName	array	No	The name of resource N. Valid values of N: 1 to 50. If ResourceType is set to user, the resource name is the name of the RAM user. Note You must specify only one of the following parameters: ResourceId and ResourcePrincipalName.
	string	No	The name of resource N. Valid values of N: 1 to 50. If ResourceType is set to user, the resource name is the name of the RAM user. Note You must specify only one of the following parameters: ResourceId and ResourcePrincipalName.	test@example.onaliyun.com
NextToken	string	No	The token that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.	caeba0bbb2be03f84eb48b699f0a4883
PageSize	integer	No	The number of entries per page. If a response is truncated because it reaches the value of PageSize, the value of IsTruncated will be true. Valid values: 1 to 100. Default value: 100.	2
ResourceType	string	No	The type of the resource. Valid value: user: a RAM user	user
ResourceId	array	No	The ID of resource N. Valid values of N: 1 to 50. If ResourceType is set to user, the resource ID is the ID of the RAM user. Note You must specify only one of the following parameters: ResourceId and ResourcePrincipalName.
	string	No	The ID of resource N. Valid values of N: 1 to 50. If ResourceType is set to user, the resource ID is the ID of the RAM user. Note You must specify only one of the following parameters: ResourceId and ResourcePrincipalName.	20732900249392****
Tag	array<object>	No	The tag value. Valid values of N: 1 to 20. N must be consecutive.
	object	No
Key	string	No	The key of tag N. Valid values of N: 1 to 20. N must be consecutive.	operator
Value	string	No	The value of tag N. Valid values of N: 1 to 20. N must be consecutive.	alice

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The marker. This parameter is returned only if the value of IsTruncated is true. If the parameter is returned, you can call this operation again and set this parameter to obtain the truncated part.	caeba0bbb2be03f84eb48b699f0a****
RequestId	string	The request ID.	4BE83135-0B08-467C-B3A2-27B312FD0F57
TagResources	object
TagResource	array<object>	The tag key.
	object
ResourceType	string	The type of the resource. Valid values: user: a RAM user	user
TagValue	string	The tag value.	alice
ResourceId	string	The ID of the resource.	20732900249392****
TagKey	string	The tag key.	operator
IsTruncated	boolean	Indicates whether the response is truncated. Valid values: true false	true

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "4BE83135-0B08-467C-B3A2-27B312FD0F57",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "user",
        "TagValue": "alice",
        "ResourceId": "20732900249392****",
        "TagKey": "operator"
      }
    ]
  },
  "IsTruncated": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.