Use ListTagResources to query tags for instances - ENS

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

ens:ListTagResources

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	Yes	The resource type. Set the value to instance.	instance
ResourceId	array	No	The IDs of resources. Valid values of N: 1 to 50.
	string	No	The ID of the resource.	i-t252vwg7cib00ky8g0q
NextToken	string	No	The token of the first page to query.	153ba0bbb2be03f84eb48b699f0a4123
Tag	array<object>	No	The tags.
	object	No
Key	string	No	The key of tag N of the instance. Valid values of N: 1 to 20. The key cannot start with `aliyun`, `acs:`, `http://`, or `https://`. The key must be up to 64 characters in length. The tag key cannot be an empty string.	team
Value	string	No	The value of a tag that is attached to the topics you want to query. This parameter is not required. If you configure this parameter, you must also configure the Key parameter.**** If you include the Key and Value parameters in a request, Queries only the topics that use the specified tags. If you do not include these parameters in a request, Queries all topics that you can access. Valid values of N: 1 to 20. The value of this parameter can be an empty string. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.	tagValue

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	C78D9B61-69D8-5655-A312-A15DA5EA5D5E
TagResources	array<object>	The tags that are added to specified one or more resources.
	object	A list of tags.
ResourceId	string	The ID of the associated resources.	i-5zy93g7z1hnkdmav84joxyzgn
ResourceType	string	The type of the resource.	instance
TagKey	string	The tag key of the instance.	test_tag_key-2
TagValue	string	The value of the tag.	CLUSTER
NextToken	string	The token of the first page to query.	abcfeg368547ccdef

Examples

Success response

JSON format

{
  "RequestId": "C78D9B61-69D8-5655-A312-A15DA5EA5D5E",
  "TagResources": [
    {
      "ResourceId": "i-5zy93g7z1hnkdmav84joxyzgn",
      "ResourceType": "instance",
      "TagKey": "test_tag_key-2",
      "TagValue": "CLUSTER"
    }
  ],
  "NextToken": "abcfeg368547ccdef"
}

Error codes

HTTP status code	Error code	Error message	Description
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
403	NoPermission	The operator is not permission for this operate

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.