ListInstances - OpenSearch - Alibaba Cloud Documentation Center

Retrieves a list of instances.

Operation description

Method

GET

URI

/openapi/ha3/instances

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:ListInstances

get

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/*

None

Request syntax

GET /openapi/ha3/instances HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
pageNumber	integer	No	The page number. The default value is 1.	1
pageSize	integer	No	The number of entries to return on each page. The default value is 10. The value must be in the range of 1 to 50.	10
instanceId	string	No	The ID of the instance.	ha-cn-pl32rf0****
description	string	No	Filters instances by description. Fuzzy matching is supported.	searchengine instance
resourceGroupId	string	No	The ID of the resource group.	rg-aekzgpiswzbksdi
edition	string	No	The edition of the instance. Valid values: vector (Vector Search Edition) and engine (Retrieval Engine Edition).	vector
tags	array<object>	No	The tags.
	object	No	The tags of the instance.
key	string	No	The tag key.	opensearch
value	string	No	The tag value.	opensearch
catalog	string	No
database	string	No
table	string	No
dataSourceType	string	No

Parameter	Type	Required	Description
status	String	No	Filters instances by status. Valid values: Running, Ready, Initializing, and Starting.
expiredTime	Long	No	A UNIX timestamp in seconds. This parameter is used to filter instances by expiration time. If the value is greater than the current time, instances that are about to expire are returned. Expired instances are not included.

Example

Sample request

GET /openapi/ha3/instances?name=test&instanceId=abc&page=1&size=10

Response elements

Element	Type	Description	Example
	object	The response schema.
result	array<object>	The returned result.
	array<object>	The details of the instance.
description	string	The description of the instance.	test
resourceGroupId	string	The ID of the resource group.	ha-cn-pl32rf0****
expiredTime	string	The expiration time.	1634885083
commodityCode	string	The commodity code.	opensearch_ha3post_public_cn
status	string	The status of the instance.	READY
instanceId	string	The ID of the instance.	ha-cn-pl32rf0****
createTime	string	The time when the instance was created.	2022-06-04T02:03:21Z
lockMode	string	The lock status.	Unlock
chargeType	string	The billing method.	POSTPAY
updateTime	string	The time when the instance was last updated.	2018-12-06T11:17:49.0
inDebt	boolean	Indicates whether the instance has an overdue payment.	false
network	object	The network information of the search engine instance.
vSwitchId	string	The ID of the virtual switch.	vsw-bp11ldcf59q2n****
vpcId	string	The ID of the virtual private cloud (VPC).	vpc-wz9axk41d9vff****
endpoint	string	The gateway endpoint.	ha-cn-35t3r****.ha.aliyuncs.com
publicEndpoint	string	The public domain name.	ha-cn-35t3ni****.public.ha.aliyuncs.com
allow	string	The whitelist for the public domain name.	127.0.0.1
tags	array<object>	The tags.
	object	The tags.
key	string	The tag key.	opensearch
value	string	The tag value.	opensearch
edition	string	The edition of the instance.vector: Vector Search Editionengine: Retrieval Engine Edition	vector
userName	string	The username.	admin
version	string	The version of the engine.	ha3_3.10.0
noQrs	boolean	Indicates whether the instance is a standalone instance.	false
spec	object	The specifications of the nodes.
qrsResource	object	The specifications of the query nodes.
category	string	The instance type. Valid values:local_ssd: local solid-state drive (SSD)cloud: disk	local_ssd
cpu	integer	The number of CPU cores.	1
mem	integer	The memory size in GB.	10
disk	integer	The storage space of the node in GB.	100
nodeCount	integer	The number of nodes.	3
searchResource	object	The specifications of the data nodes.
category	string	The instance type. Valid values:local_ssd: local SSDcloud: disk	local_ssd
cpu	integer	The number of CPU cores.	1
mem	integer	The memory size in GB.	10
disk	integer	The storage space of the node in GB.	100
nodeCount	integer	The number of nodes.	3
dataSourceDetails	array<object>
	array<object>
indexName	string
type	string
config	object
endpoint	string
accessKey	string
project	string
partition	string
table	string
namespace	string
path	string
ossPath	string
bucket	string
catalog	string
database	string
tag	string
totalCount	integer	The total number of entries.	5
requestId	string	The ID of the request.	89B968E6-1E41-58DF-BB25-5F98ECC759CE

Sample responses

Sample success response

{
    "result":
    [
        {
            "inDebt": false,
            "lockMode": "Unlock",
            "trFreeUrl": "",
            "chargeType": "POSTPAY",
            "edition": "engine",
            "description": "test",
            "updateTime": "2024-05-06 14:08:24.0",
            "userName": "admin",
            "version": "ha3_3.10.0",
            "spec":
            {
                "qrsResource":
                {
                    "category": "local_ssd",
                    "cpu": 2,
                    "mem": 8,
                    "disk": 100,
                    "nodeCount": 5
                },
                "searchResource":
                {
                    "category": "local_ssd",
                    "cpu": 2,
                    "mem": 16,
                    "disk": 100,
                    "nodeCount": 4
                }
            },
            "network":
            {
                "vSwitchId": "vsw-bp179zkffzyva26ua8xil",
                "vpcId": "vpc-bp1956duqqe2lm2lvqjf1",
                "endpoint": "ha-cn-35t3ni61z06.ha.aliyuncs.com",
                "publicEndpoint": "ha-cn-35t3ni61z06.public.ha.aliyuncs.com",
                "allow": "127.0.0.1"
            },
            "tags":
            [
                {
                    "value": "rg-acfmv2hk2jpsxia",
                    "key": "acs:rm:rgId"
                }
            ],
            "noQrs": false,
            "instanceId": "ha-cn-35t3ni61z06",
            "createTime": "2024-03-14 10:49:32.0",
            "commodityCode": "opensearch_ha3post_public_cn",
            "resourceGroupId": "rg-acfmv2hk2jpsxia",
            "status": "READY"
        }
    ],
    "requestId": "949FDF5E-6FF6-13B9-A196-59B25F143B7F",
    "totalCount": 1
}

Sample error response

{
  "requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
  "httpCode": 404,
  "code": "App.NotFound",
  "message": "App not found"
}

Examples

Success response

JSON format

{
  "result": [
    {
      "description": "test",
      "resourceGroupId": "ha-cn-pl32rf0****",
      "expiredTime": "1634885083",
      "commodityCode": "opensearch_ha3post_public_cn",
      "status": "READY",
      "instanceId": "ha-cn-pl32rf0****",
      "createTime": "2022-06-04T02:03:21Z",
      "lockMode": "Unlock",
      "chargeType": "POSTPAY",
      "updateTime": "2018-12-06T11:17:49.0",
      "inDebt": false,
      "network": {
        "vSwitchId": "vsw-bp11ldcf59q2n****",
        "vpcId": "vpc-wz9axk41d9vff****",
        "endpoint": "ha-cn-35t3r****.ha.aliyuncs.com",
        "publicEndpoint": "ha-cn-35t3ni****.public.ha.aliyuncs.com",
        "allow": "127.0.0.1"
      },
      "tags": [
        {
          "key": "opensearch",
          "value": "opensearch"
        }
      ],
      "edition": "vector",
      "userName": "admin",
      "version": "ha3_3.10.0",
      "noQrs": false,
      "spec": {
        "qrsResource": {
          "category": "local_ssd",
          "cpu": 1,
          "mem": 10,
          "disk": 100,
          "nodeCount": 3
        },
        "searchResource": {
          "category": "local_ssd",
          "cpu": 1,
          "mem": 10,
          "disk": 100,
          "nodeCount": 3
        }
      },
      "dataSourceDetails": [
        {
          "indexName": "",
          "type": "",
          "config": {
            "endpoint": "",
            "accessKey": "",
            "project": "",
            "partition": "",
            "table": "",
            "namespace": "",
            "path": "",
            "ossPath": "",
            "bucket": "",
            "catalog": "",
            "database": "",
            "tag": ""
          }
        }
      ]
    }
  ],
  "totalCount": 5,
  "requestId": "89B968E6-1E41-58DF-BB25-5F98ECC759CE"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.