ListInstances - OpenSearch - Alibaba Cloud Documentation Center

Queries a list of instances.

Operation description

Method

GET

URI

/openapi/ha3/instances

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /openapi/ha3/instances

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

Parameter	Type	Description	Example
	object	The response parameters.
result	array<object>	The results returned.
	object	InstanceItemType
description	string	The description of the instance.	Emergency test
resourceGroupId	string	The ID of the resource group.	rg-aekzgpiswzbksdi
expiredTime	string	The time when the instance expires.	1634885083
commodityCode	string	The commodity code of the instance.	""
status	string	The instance status.	2
instanceId	string	The instance ID.	ha-cn-2r42n8oh001
createTime	string	The time when the instance was created.	2022-06-04T02:03:21Z
lockMode	string	The lock state of the instance.	Unlock
chargeType	string	The billing method.	PrePaid
updateTime	string	The time when the instance was updated.	2018-12-06T11:17:49.0
inDebt	boolean	Indicates whether an overdue payment is involved.	false
network	object	The network information of the instance.
vSwitchId	string	The vSwitch ID.	vsw-bp11ldcf59q2nbwkqgj6z
vpcId	string	The ID of the virtual private cloud (VPC) in which the instance is deployed.	vpc-wz9axk41d9vffoc79x0oe
endpoint	string	The instance endpoint.	""
tags	array<object>	The tags of the instance.
	object
key	string	The tag key.	env
value	string	The tag value.	oboms-disk
totalCount	integer	The total number of entries returned	5
requestId	string	The ID of the request	89B968E6-1E41-58DF-BB25-5F98ECC759CE

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-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