ListTagResources API Overview for RAM Tag Queries - Resource Access Management - Alibaba Cloud - Resource Access Management

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
ResourceType	string	Yes	The resource type. Enumerated values: role: RAM roles. policy: policies. Valid values: role : RAM role policy : policy	role
ResourceNames	array	No	The names of the resources. You can specify up to 50 resource names.
	string	No	The name of the resource.	role1
Tag	array<object>	No	The tags. You can specify up to 20 tags.
	object	No	The tag.
Key	string	No	The key of the tag. The tag key can be up to 128 characters in length.	t1
Value	string	No	The value of the tag. The tag value can be up to 256 characters in length.	v1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100.	100
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	GY/oWREsOP1bPHGcHGrXfYX7UG1k9KqWFYThNDPx1UX26PbWOIu2CMqqiMr68H/K

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	5CCE804C-6450-49A7-B1DB-2460F7A97416
TagResources	array<object>	The tags that are added to the cloud resources.
	object	The tag that is added to the cloud resources.
ResourceName	string	The name of the resource.	role1
ResourceType	string	The resource type. Enumerated values: role: RAM roles. policy: policies. Valid values: role : RAM role policy : policy	role
TagKey	string	The key of the tag.	t1
TagValue	string	The value of the tag.	v1
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	GY/oWREsOP1bPHGcHGrXfYX7UG1k9KqWFYThNDPx1UX26PbWOIu2CMqqiMr68H/K

Examples

Success response

JSON format

{
  "RequestId": "5CCE804C-6450-49A7-B1DB-2460F7A97416",
  "TagResources": [
    {
      "ResourceName": "role1",
      "ResourceType": "role",
      "TagKey": "t1",
      "TagValue": "v1"
    }
  ],
  "NextToken": "GY/oWREsOP1bPHGcHGrXfYX7UG1k9KqWFYThNDPx1UX26PbWOIu2CMqqiMr68H/K"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.