All Products
Search
Document Center

Elastic Compute Service:ListTagResources

Last Updated:Jul 31, 2024

Queries the tags that are added to one or more Elastic Block Storage (EBS) resources, or queries the IDs and tags of resources in a specified 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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ebs:ListTagResourceslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceIdarrayNo

The ID list of the resource. You can specify up to 50 resource IDs in each call.

stringNo

The ID of resource N. Valid values of N: 1 to 50.

pair-cn-c4d2t7f****
Tagarray<object>No

The information about the tags.

You can specify at most 20 tags in each call.

objectNo

The tags that you want to attach to the resource.

KeystringNo

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
ValuestringNo

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
NextTokenstringNo

The token used to start the next query.

token123
RegionIdstringYes

The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ResourceTypestringYes

The type of the resource. Valid values:

  • dedicatedblockstoragecluster: dedicated block storage cluster
  • diskreplicapair: replication pair
  • diskreplicagroup: replication pair-consistent group
diskreplicagroup
ClientTokenstringNo

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 parameters

ParameterTypeDescriptionExample
object

ListTagResourcesResponse

NextTokenstring

The token used to start the next query.

caeba0bbb2be03f84eb48b699f0a****
TagResourcesarray<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.

TagKeystring

The tag key of the resource.

TestKey
TagValuestring

The tag value of the resource.

TestValue
ResourceIdstring

The ID of the resource.

pair-cn-c4d2t7f****
ResourceTypestring

The type of the resource. Valid values:

  • dedicatedblockstoragecluster: dedicated block storage cluster
  • diskreplicapair: replication pair
  • diskreplicagroup: replication pair-consistent group
pair
RequestIdstring

The ID of the request. The request ID is returned regardless of whether the call is successful.

484256DA-D816-44D2-9D86-B6EE4D5B****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe parameter %s is invalid.The specified parameter value is invalid.
400InvalidParameter.ConflictThe specified parameter %s and %s are not blank at the same time.-
400InvalidParameter.FormatSpecified parameter format is not valid.english description
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.The parameter must be specified.
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.-
400NumberExceed.ResourceIdsThe ResourceIds parameter number is exceed , Valid : 50-
400NumberExceed.TagsNumberExceed.Tags-
400OperationDenied.QuotaExceedThe quota of tags on resource is beyond permitted range.-
400IdempotentParameterMismatchThe specified parameter has changed while using an already used clientToken.The request and a previous request contains the same client token but different parameters.
403ForbiddenUser is not authorized to operate.You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403Forbidden.ActionUser 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.
403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.-
403LastTokenProcessingThe last token request is processing.The value of clientToken is used in another request that is being processed. Try again later.
403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.You are not authorized to create service-linked roles.
403OperationDeniedThe operation is not allowed.The operation is not supported.
404InvalidApi.NotFoundSpecified api is not found, please check your url and method.-
404InvalidRegionId.NotFoundThe specified RegionId does not exist.-
404InvalidResourceId.NotFoundThe specified ResourceIds are not found in our records.-
404InvalidResourceType.NotFoundThe ResourceType provided does not exist in our records.-
404NoSuchResourceThe specified resource does not exist.The specified resource does not exist.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error has occurred.
504RequestTimeoutThe request is timeout, please try again later.The request has timed out. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history