Queries the instances that meet the specified conditions.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| lindorm:GetLindormInstanceList | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The ID of the region in which the instances that you want to query is located. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| QueryStr | string | No | The keyword contained in the names of Lindorm instances you want to query. Fuzzy queries based on the keyword is supported. | test |
| PageNumber | integer | Yes | The number of the pages to return, | 1 |
| PageSize | integer | Yes | The number of instances to return on each page. | 20 |
| ServiceType | string | No | The series of instances that you want to query. Valid values:
| lindorm |
| SupportEngine | integer | No | The engine supported by the instances that you want to query. The engines are indicated by different numbers:
Note
The value of this parameter is the sum of all numbers that indicate the engines supported by the instance. For example, if you set the value of this parameter to 15, which is the sum of 1, 2, 4, and 8, this operation queries instances that support all four engines. If you set the value of this parameter to 6, which is the sum of 2 and 4, this operation queries instances that support LindormTSDB and LindormTable.
| 15 |
| Tag | array<object> | No | The list of tags associated with the specified instances. | |
| object | No | The tags associated with the specified instances. | ||
| Key | string | No | The key of tag N of the instances you want to query. You can specify 1 to 20 tag keys. Note
You can specify the keys of multiple tags. For example, you can specify the key of the first tag in the first key-value pair contained in the value of this parameter and specify the key of the second tag in the second key-value pair.
| test |
| Value | string | No | The value of tag N of the instances you want to query. You can specify 1 to 20 tag values. Note
You can specify the values of multiple tags. For example, you can specify the value of the first tag in the first key-value pair contained in the value of this parameter and specify the value of the second tag in the second key-value pair.
| 2.2.18 |
| ResourceGroupId | string | No | The ID of the resource group to which the instance belongs. | rg-aek3b63arvg27vi |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1CA1FAFD-E8DC-51C2-AA7E-CA6E2D049BA0",
"PageNumber": 1,
"PageSize": 20,
"Total": 1,
"InstanceList": [
{
"VpcId": "vpc-bp1n3i15v90el48nx****",
"EngineType": "15",
"ExpireTime": "2022-04-26 00:00:00",
"CreateTime": "2021-09-16 14:13:13",
"PayType": "PREPAY",
"AliUid": 0,
"InstanceStorage": "960",
"InstanceId": "ld-bp17pwu1541ia****",
"NetworkType": "vpc",
"ServiceType": "lindorm",
"RegionId": "cn-hangzhou",
"CreateMilliseconds": 1631772842000,
"InstanceAlias": "test",
"ZoneId": "cn-hangzhou-h",
"InstanceStatus": "ACTIVATION",
"ExpiredMilliseconds": 1650902400000,
"EnableStream": true,
"Tags": [
{
"Key": "test",
"Value": "2.2.18"
}
],
"EnableCompute": true,
"ResourceGroupId": "rg-aekzledqeat****",
"EnableMessage": true,
"EnableVector": true,
"EnableLts": true,
"EnableColumn": true
}
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Instance.IsDeleted | The instance is deleted. | The specified instance is already deleted. |
| 400 | Instance.IsNotAvailable | The instance is unavailable. | The specified instance is unavailable. |
| 403 | Lindorm.Errorcode.OperationDenied | You are not authorized to operate on the specified resource. | - |
| 403 | API.Forbidden | The API operation is forbidden in this environment. | This operation is not supported in the current environment. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-23 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-03-29 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-02-19 | The Error code has changed | View Change Details |
| 2023-11-15 | The Error code has changed | View Change Details |