Queries for Lindorm instances and their associated tags.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The ID of the region where the instance is located. Call the DescribeRegions operation to get the region ID. |
cn-hangzhou |
| ResourceId |
array |
No |
A list of resource IDs. |
|
|
string |
No |
The ID of the instance. To query the relationships between multiple instances and their tags, pass multiple instance IDs. Call the GetLindormInstanceList operation to get the instance IDs. |
ld-bp17j28j2y7pm**** |
|
| NextToken |
string |
No |
The token to start the next query to retrieve more results. Note
This parameter is not required for the first query. If a query does not return all results, pass the NextToken value from the previous response in the next query to continue. |
212db86**** |
| ResourceType |
string |
Yes |
The type of the resource. Set the value to INSTANCE. |
INSTANCE |
| Tag |
array<object> |
No |
A list of tags. |
|
|
object |
No |
|||
| Key |
string |
No |
The key of the tag. Note
You can specify multiple tag keys. For example, the Key in the first key-value pair specifies the key of the first tag, and the Key in the second key-value pair specifies the key of the second tag. |
test |
| Value |
string |
No |
The value of the tag. Note
You can specify multiple tag values. For example, the Value in the first key-value pair specifies the value of the first tag, and the Value in the second key-value pair specifies the value of the second tag. |
2.2.8 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
05CB115C-91CB-529F-9098-50C1F6CB3BD3 |
| TagResources |
array<object> |
A list of resources. |
|
|
object |
|||
| ResourceType |
string |
The resource type. The value is always ALIYUN::HITSDB::INSTANCE. |
ALIYUN::HITSDB::INSTANCE |
| TagValue |
string |
The value of the tag. |
2.2.8 |
| ResourceId |
string |
The resource ID. This is the instance ID. |
ld-bp17j28j2y7pm**** |
| TagKey |
string |
The key of the tag. |
test |
| NextToken |
string |
The token for the next query. Note
This parameter is returned if a query does not return all results. Pass the value of this parameter in the next query to continue. |
212db86**** |
Examples
Success response
JSON format
{
"RequestId": "05CB115C-91CB-529F-9098-50C1F6CB3BD3",
"TagResources": [
{
"ResourceType": "ALIYUN::HITSDB::INSTANCE",
"TagValue": "2.2.8",
"ResourceId": "ld-bp17j28j2y7pm****",
"TagKey": "test"
}
],
"NextToken": "212db86****"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Lindorm.Errorcode.MissingParameter | You must specify ResourceId.N or Tags | |
| 400 | Lindorm.Errorcode.NumberExceed.Tags | The maximum number of Tags is exceeded. | |
| 400 | Lindorm.Errorcode.NumberExceed.ResourceIds | The maximum number of ResourceIds is exceeded. | |
| 403 | API.Forbidden | The API operation is forbidden in this environment. | This operation is not supported in the current environment. |
| 403 | Lindorm.Errorcode.OperationDenied | You are not authorized to operate on the specified resource. | You are not authorized to manage the specified resource. |
| 403 | Lindorm.Errorcode.ServiceLinkedRoleNoPermission | No permission to create service linked role. | You are not authorized to create the service-linked role. |
| 404 | Lindorm.Errorcode.InstanceNotFound | The instance is not found. | The specified instance does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.