ListTagResources - Auto Scaling - Alibaba Cloud Documentation Center

Queries the tags that are attached to one or more Auto Scaling resources.

Operation description

Specify at least one request parameter: ResourceId.N or Tag.N (Tag.N.Key and Tag.N.Value) to determine the query object.
If you specify both Tag.N and ResourceId.N, the response contains only Auto Scaling resources that meet both conditional criteria.

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

ess:ListTagResources

get

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the resource. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ResourceType	string	Yes	The resource type. Only scaling groups are supported. Valid values: scalinggroup.	scalinggroup
NextToken	string	No	The token that determines the start point of the next query.	caeba0bbb2be03f84eb48b699f0a4883
ResourceId	array	No	The resource ID. Valid values of N: 1 to 50.	asg-bp17xb4x1vr29lgt****
	string	No	The resource ID. Valid values of N: 1 to 50.	asg-bp17xb4x1vr29lgt****
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key that is used to perform an exact search for Auto Scaling resources. The tag key must be 1 to 128 characters in length. Valid values of N: 1 to 20. `Tag.N` is used to perform an exact search for Auto Scaling resources that have the specified tags attached. A tag is a key-value pair. If you specify only `Tag.N.Key`, all resources that are associated with the tag key are returned. If you specify only `Tag.N.Value`, the `MissingParameter.TagKey` error is returned. If you specify multiple tag key-value pairs at the same time, only Auto Scaling resources that match all the specified tag key-value pairs are returned.	TestKey
Value	string	No	The tag value that is used to perform an exact search for Auto Scaling resources. The tag value can be an empty string. The tag value can be up to 128 characters in length. Valid values of N: 1 to 20.	TestValue

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token that determines the start point of the next query.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The request ID.	DE65F6B7-7566-4802-9007-96F2494A****
TagResources	object
TagResource	array<object>	The collection of resources and tags, which contains information such as the resource ID, resource type, and tag key-value pairs.
	object	The collection of resources and tags, which contains information such as the resource ID, resource type, and tag key-value pairs.
TagValue	string	The tag value of the resource.	TestValue
ResourceType	string	The resource type.	ALIYUN::ESS::SCALINGGROUP
ResourceId	string	The resource ID.	asg-bp17xb4x1vr29lgt****
TagKey	string	The tag key of the resource.	TestKey
Propagate	boolean	Indicates whether the tag is a propagatable tag. Valid values: true: The tag on the scaling group is propagated only to instances that are about to be created during scale-out events. The tag is not propagated to instances that are already running in the scaling group. false: The tag on the scaling group is not propagated to instances.	false

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "DE65F6B7-7566-4802-9007-96F2494A****",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "TestValue",
        "ResourceType": "ALIYUN::ESS::SCALINGGROUP",
        "ResourceId": "asg-bp17xb4x1vr29lgt****",
        "TagKey": "TestKey",
        "Propagate": false
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.