DescribeResourceByTags - Elastic Compute Service - Alibaba Cloud Documentation Center

The DescribeResourceByTags operation retrieves resources by tag or resource type.

Note

This API has been deprecated. We recommend migrating to Tag(2018-08-28) - ListResourcesByTag for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

ecs:DescribeResourceByTags

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 50.	50
PageNumber	integer	No	The page number to return. The minimum value is 1. Default value: 1.	1
ResourceType	string	No	The resource type. Valid values: `instance`: ECS instance. `disk`: disk. `snapshot`: snapshot. `image`: image. `securitygroup`: security group. `volume`: volume. `eni`: elastic network interface. `ddh`: dedicated host. `keypair`: key pair. `launchtemplate`: launch template. All values must be in lowercase.	instance
RegionId	string	Yes	The ID of the region where the resource is located. You can call DescribeRegions to view the latest list of Alibaba Cloud regions.	cn-hangzhou
Tag	array<object>	No	The tag list.
	object	No	A tag object.
key	string	No	The tag key. Note For best compatibility, we recommend that you use the `Tag.N.Key` parameter.	testkey
Key	string	No	The tag key. Note For best compatibility, we recommend that you use the `Tag.N.Key` parameter.	TestKey
Value	string	No	The tag value. An empty string is allowed. The value can be up to 128 characters in length.	TestValue
value	string	No	The tag value. An empty string is allowed. The value can be up to 128 characters in length.	testvalue

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1C1E5359-71D7-44D8-8FAA-0327B549157X
PageSize	integer	The number of entries per page.	50
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of resources.	8
Resources	object
Resource	array<object>	The information about the resources to which the tags are added.
	object
ResourceType	string	The resource type.	instance
ResourceId	string	The resource ID.	i-bp16t2cgmiiy7t1c****
RegionId	string	The region ID.	cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "1C1E5359-71D7-44D8-8FAA-0327B549157X",
  "PageSize": 50,
  "PageNumber": 1,
  "TotalCount": 8,
  "Resources": {
    "Resource": [
      {
        "ResourceType": "instance",
        "ResourceId": "i-bp16t2cgmiiy7t1c****",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTagCount	The specified tags are beyond the permitted range.	The number of specified tags exceeds the upper limit.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	The specified region ID does not exist.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	The specified resource type does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.