ListTagResources

Updated at:
Copy as MD

Queries the tags bound to one or more EAIS resources.

Operation description

Specify at least one of the following parameters in the request to determine the query object:

  • ResourceId.N

  • Tag.N (Tag.N.Key and Tag.N.Value)

If you specify both the Tag.N and ResourceId.N parameters, the returned results contain only the EAIS resources that meet both conditions.

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

eais:ListTagResources

none

*Instance

acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID of the resource. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

NextToken

string

No

The next token.

caeba0bbb2be03f84eb48b699f0a4884

ResourceType

string

Yes

The resource type. Valid value: instance.

instance

ResourceId

array

No

The resource IDs. You can specify up to 50 resource IDs.

string

No

The resource ID.

eais-hzs4h26yyt5xkcke****

Tag

array<object>

No

The tags. You can specify up to 20 tags.

object

No

The tag.

Key

string

No

The tag key. Limits:

  • It cannot be empty.

  • It can be up to 128 characters in length.

  • It cannot start with aliyun or acs:.

  • It cannot contain http:// or https://.

TestKey

Value

string

No

The tag value. Limits:

  • It can be up to 128 characters in length.

  • It cannot start with aliyun or acs:.

  • It cannot contain http:// or https://.

TestValue

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

F23AEEC7-4D98-4657-A104-02692701****

NextToken

string

The next token. An empty value indicates that no more results are available.

caeba0bbb2be03f84eb48b699f0a4885

TagResources

array<object>

The collection of resources and their tags, which includes information such as the resource ID, resource type, and tag key-value pairs.

object

The resource and tag information.

TagKey

string

The tag key.

TestKey

TagValue

string

The tag value.

TestValue

ResourceId

string

The resource ID.

eais-hzs4h26yyt5xkcke****

ResourceType

string

The resource type.

instance

Examples

Success response

JSON format

{
  "RequestId": "F23AEEC7-4D98-4657-A104-02692701****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4885",
  "TagResources": [
    {
      "TagKey": "TestKey",
      "TagValue": "TestValue",
      "ResourceId": "eais-hzs4h26yyt5xkcke****",
      "ResourceType": "instance"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 MissingParameter.ResourceIdOrTag Either ResourceId or Tag must be specified.
400 InvalidNextToken The NextToken is invalid.
400 NumberExceed.ResourceIds The maximum number of ResourceIds is exceeded. The maximum is 50.
400 MissingParameter.ResourceIds You must specify ResourceIds.
400 Duplicate.ResourceId The request contains duplicated ResourceId.
400 NumberExceed.Tags The maximum number of Tags is exceeded. The maximum is 20.
400 Duplicate.TagKey The Tag.N.Key contains a duplicated key.
400 InvalidResourceId.NotFound The ResourceId does not exist.
400 InvalidParameter.TagKey The specified Tag.n.Key is invalid.
400 InvalidParameter.TagValue The specified Tag.n.Value is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.