ListTagResources - Query tags on Auto Scaling resources - Auto Scaling

Operation description

Specify at least one of the following parameters: ResourceIds or Tags (Tags.Key and Tags.Value).
If you specify both ResourceIds and Tags, only resources that match both criteria 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

ess:ListTagResources

get

*ScalingGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Call DescribeRegions to query available regions.	cn-hangzhou
ResourceType	string	Yes	The resource type. Set the value to scalinggroup.	scalinggroup
NextToken	string	No	The token that determines the start point of the next query.	caeba0bbb2be03f84eb48b699f0a4883
ResourceIds	array	No	The IDs of the Auto Scaling resources. You can specify 1 to 50 resource IDs.
	string	No	The IDs of the Auto Scaling resources. You can specify 1 to 50 resource IDs.	asg-bp17xb4x1vr29lgt****
Tags	array<object>	No	Details of the tags.
	object	No	Details of the tags.
Key	string	No	The tag key for exact matching. Must be 1 to 128 characters. `Tags` performs exact matching on Auto Scaling resources. Specify tags as key-value pairs. If you specify only `Tags.Key`, all resources with the specified key are returned. If you specify only `Tags.Value`, the `MissingParameter.TagKey` error is returned. If you specify multiple key-value pairs, only resources that match all pairs are returned.	TestKey
Value	string	No	The tag value for exact matching. Can be up to 128 characters.	TestValue

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that determines the start point of the next query.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	The ID of the request.	DE65F6B7-7566-4802-9007-96F2494A****
TagResources	array<object>	The resource and tag details, including resource ID, resource type, tag key, and tag value.
	object	The resource and tag details.
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	Whether the scaling group tags propagate to instances. Valid values: true: Tags propagate to newly created instances only. false: Tags do not propagate to instances.	false

Examples

Success response

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "DE65F6B7-7566-4802-9007-96F2494A****",
  "TagResources": [
    {
      "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.