ListTagResources
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
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
eais:ListTagResources |
none |
*Instance
|
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 |
| 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:
|
TestKey |
| Value |
string |
No |
The tag value. Limits:
|
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.