Queries a list of instances.
Operation description
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 |
|---|---|---|---|---|
| searchengine:ListInstances | get |
|
| none |
Request syntax
GET /openapi/ha3/instances HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| pageNumber | integer | No | The number of the page to return. Default value: 1. | 1 |
| pageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 50. Default value: 10. | 10 |
| instanceId | string | No | The instance ID. | ha-cn-83570439y0n |
| description | string | No | The description of the instance. You can use this description to filter instances. Fuzzy match is supported. | Havenask instance |
| resourceGroupId | string | No | The ID of the resource group to which the instance belongs. | rg-aekzgpiswzbksdi |
| edition | string | No | The instance type. Valid values: vector: OpenSearch Vector Search Edition instance. engine: OpenSearch Retrieval Engine Edition instance. | vector |
| tags | array<object> | No | The tags of the instance. | |
| object | No | |||
| key | string | No | The tag key. | backup |
| value | string | No | The tag value. | oboms-disk |
| Parameter | Type | Required | Description |
|---|---|---|---|
| status | String | No | The status of the instance. You can filter instances by status. Valid values: Running, Ready, Initializing,Starting |
| expiredTime | Long | No | The time when the instance expires. The value of this parameter must be accurate to the second. Only instances whose expiration time is greater than the value of this parameter will be returned. The instances that have already expired will not be returned. |
Example
Sample requests
GET /openapi/ha3/instances?name=test&instanceId=abc&page=1&size=10
Response parameters
Sample responses
Sample success responses
{
"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
"result": [
{
"instanceId": "igraph-cn-xxxxxx1",
"spec": {
"password": "passwd",
"searchResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"instanceName": "testInstance",
"vSwitchId": "vswitch_id_xxx",
"vpcId": "vpc_id_xxx",
"qrsResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"region": "cn-hangzhou",
"userName": "user"
},
"status": {
"phase": "PENDING",
"instancePhase": "INIT",
"createSuccess": false
}
},
{
"instanceId": "igraph-cn-xxxxxx2",
"spec": {
"password": "passwd",
"searchResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"instanceName": "testInstance",
"vSwitchId": "vswitch_id_xxx",
"vpcId": "vpc_id_xxx",
"qrsResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"region": "cn-hangzhou",
"userName": "user"
},
"status": {
"phase": "PENDING",
"instancePhase": "INIT",
"createSuccess": false
}
}
],
"totalCount": 20
}
Sample error responses
{
"requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
"httpCode": 404,
"code": "App.NotFound",
"message": "App not found"
}
Examples
Sample success responses
JSONformat
{
"result": [
{
"description": "Emergency test\n",
"resourceGroupId": "rg-aekzgpiswzbksdi",
"expiredTime": "1634885083",
"commodityCode": "\"\"",
"status": "2",
"instanceId": "ha-cn-2r42n8oh001",
"createTime": "2022-06-04T02:03:21Z",
"lockMode": "Unlock",
"chargeType": "PrePaid",
"updateTime": "2018-12-06T11:17:49.0",
"inDebt": false,
"network": {
"vSwitchId": "vsw-bp11ldcf59q2nbwkqgj6z",
"vpcId": "vpc-wz9axk41d9vffoc79x0oe",
"endpoint": "\"\""
},
"tags": [
{
"key": "env",
"value": "oboms-disk"
}
]
}
],
"totalCount": 5,
"requestId": "89B968E6-1E41-58DF-BB25-5F98ECC759CE"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-17 | The response structure of the API has changed | View Change Details |
| 2024-06-28 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2022-01-12 | Add Operation | View Change Details |