Query tags and resources by using ListTagResources - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the tags that are added to EBS resources, or queries the IDs and tags of resources in a non-default resource group.

Operation description

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

ResourceId.N
Tag.N parameter pair (Tag.N.Key and Tag.N.Value)

If you set Tag.N and ResourceId.N at the same time, the EBS resources that match both the parameters are returned.

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

ebs:ListTagResources

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceId	array	No	The ID list of the resource. You can specify up to 50 resource IDs in each call.	disk-123
	string	No	The ID of resource N. Valid values of N: 1 to 50.	pair-cn-c4d2t7f****
Tag	array<object>	No	The information about the tags. You can specify at most 20 tags in each call.
	object	No	The tags that you want to attach to the resource.
Key	string	No	The key of tag N used for exact search of EBS resources. The tag key must be 1 to 128 characters in length. Valid values of N: 1 to 20. The `Tag.N` parameter pair (Tag.N.Key and Tag.N.Value) is used for exact search of EBS resources that have specified tags added. Each tag is a key-value pair. If you specify only `Tag.N.Key`, all EBS resources whose tags contain the specified tag key are returned. If you specify only `Tag.N.Value`, the `InvalidParameter.TagValue` error is returned. If you specify multiple tag key-value pairs at the same time, only EBS resources that match all tag key-value pairs are returned.	tag-key
Value	string	No	The value of tag N used for exact search of EBS resources. The tag value must be 1 to 128 characters in length. Valid values of N: 1 to 20.	tag-value
NextToken	string	No	The token used to start the next query.	token123
RegionId	string	Yes	The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ResourceType	string	Yes	The type of the resource. Valid values: dedicatedblockstoragecluster: dedicated block storage cluster diskreplicapair: replication pair diskreplicagroup: replication pair-consistent group	diskreplicagroup
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	0c593ea1-3bea-11e9-b96b-88e9fe63****

Response elements

Element	Type	Description	Example
	object	ListTagResourcesResponse
NextToken	string	The token used to start the next query.	caeba0bbb2be03f84eb48b699f0a****
TagResources	array<object>	Details about the resources and tags, including resource IDs, resource types, and tag key-value pairs.
	object	The details about the resource to which the tags are added.
TagKey	string	The tag key of the resource.	TestKey
TagValue	string	The tag value of the resource.	TestValue
ResourceId	string	The ID of the resource.	pair-cn-c4d2t7f****
ResourceType	string	The type of the resource. Valid values: dedicatedblockstoragecluster: dedicated block storage cluster diskreplicapair: replication pair diskreplicagroup: replication pair-consistent group	pair
RequestId	string	The ID of the request. The request ID is returned regardless of whether the call is successful.	484256DA-D816-44D2-9D86-B6EE4D5B****

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "TagResources": [
    {
      "TagKey": "TestKey",
      "TagValue": "TestValue",
      "ResourceId": "pair-cn-c4d2t7f****",
      "ResourceType": "pair"
    }
  ],
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5B****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter %s is invalid.	The specified parameter value is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.	english description
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	The parameter must be specified.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.
400	NumberExceed.ResourceIds	The ResourceIds parameter number is exceed , Valid : 50
400	NumberExceed.Tags	NumberExceed.Tags
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.
400	IdempotentParameterMismatch	The specified parameter has changed while using an already used clientToken.	The request and a previous request contains the same client token but different parameters.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.	The value of clientToken is used in another request that is being processed. Try again later.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.	You are not authorized to create service-linked roles.
403	OperationDenied	The operation is not allowed.	The operation is not supported.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.