ListTagResources-Auto Scaling(ESS)-阿里云帮助中心

Queries the labels that are attached to one or more elastic scaling resources.

Operation description

Specify at least one of the following request parameters: 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 elastic scaling resources that satisfy 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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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 used to perform an exact search for Elastic 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 Elastic scaling resources that have the specified tag bound. Tag.N consists of 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 Elastic scaling resources that match all the specified tag key-value pairs are returned.	TestKey
Value	string	No	The label value used to perform an exact search for elastic scaling resources. The label value can be an empty string. Maximum length: 128 characters. 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 their tags, which contains information such as the resource ID, resource type, and tag key-value pairs.
	object	The collection of resources and their tags, which contains information such as the resource ID, resource type, and tag key-value pairs.
TagValue	string	The value of the tag.	TestValue
ResourceType	string	The type of the resource.	ALIYUN::ESS::SCALINGGROUP
ResourceId	string	The ID of the resource.	asg-bp17xb4x1vr29lgt****
TagKey	string	The key of the tag.	TestKey
Propagate	boolean	Indicates whether the tag can be propagated. true: The tag can be propagated only to instances that are to be added to the scaling group. The tag cannot be propagated to instances that are already running in the scaling group. false: The tag cannot be propagated to an instance.	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.