List All OpenSearch Clusters via ListClusters API - OpenSearch

Queries clusters.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/clusters

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

list

*Instance

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

None

Request syntax

GET /openapi/ha3/instances/{instanceId}/clusters HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Sample requests

GET /openapi/ha3/instances/ha3_instance_name/clusters

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	id of request	F43E8AB4-419C-5F4C-90D6-615590DFAA3C
result	array<object>	The clusters.
	array<object>	The list of clusters.
name	string	The cluster name.	hz_pre_vpc_domain_1
description	string	The description of the cluster.	CustomDescription
currentAdvanceConfigVersion	string	The effective advanced configuration version.	ha-cn-pl32rf0****_offline_adv_v1
latestAdvanceConfigVersion	string	The latest advanced configuration version.	ha-cn-pl32rf0****_offline_adv_v1
currentOnlineConfigVersion	string	The effective online configuration version.	ha-cn-pl32rf0****_offline_adv_v1
latestOnlineConfigVersion	string	The latest online configuration version.	ha-cn-pl32rf0****_offline_adv_v1
currentOnlineQueryConfigVersion	string	The effective query configuration version.	ha-cn-pl32rf0****_offline_adv_v1
latestOnlineQueryConfigVersion	string	The latest query configuration version.	ha-cn-pl32rf0****_offline_adv_v1
currentOfflineDictConfigVersion	string	The effective dictionary configuration version.	ha-cn-pl32rf0****_offline_adv_v1
latestOfflineDictConfigVersion	string	The latest dictionary configuration version.	ha-cn-pl32rf0****_offline_adv_v1
configUpdateTime	string	The time when the configuration was updated.	2024-05-21 16:05:26
status	string	The cluster status. Valid values: running: The cluster is running. starting: The cluster is being started. stopping: The cluster is being stopped. stopped: The cluster is stopped.	running
queryNode	object	The information about Query Result Searcher (QRS) workers.
name	string	The name of the QRS worker.	ha-cn-pl32rf0****_qrs
number	integer	The number of QRS workers.	1
partition	integer	The ID of the partition that is stored on the QRS worker.	1
dataNode	object	The information about Searcher workers.
name	string	The name of the Searcher worker.	general
number	integer	The number of Searcher workers.	1
partition	integer	The ID of the partition that is stored on the Searcher worker.	1
createTime	string	The time when the cluster was created.	2024-05-21 16:05:26
config	object	The configuration information.
	object	The configuration information.
	object	The information about child configuration items.
name	string	The configuration name.	ha-cn-pl32rf0****_offline_adv_v1
updateTime	string	The time when the configuration was updated.	2024-05-21 16:05:26
desc	string	The description of the configuration.	CustomDescription

ResponseExample

Correct response

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": [
    {
      "name": "cluster1",
      "configUpdateTime": "2021-08-09 00:01:02",
      "currentAdvanceConfigVersion": "test_yyds_data1",
      "lastestAdvanceConfigVersion": "test_yyds_data1",
      "currentOnlineConfigVersion": "test_yyds_data1",
      "lastestOnlineConfigVersion": "test_yyds_data1",        
      "description": "airecpre",
      "queryNode": {
        "number": 1
      },
      "dataNode": {
        "number": 2,
        "partition": 1
      },      
    },
    {
      "name": "cluster2",
      "configUpdateTime": "2021-08-09 00:01:02",
      "currentAdvanceConfigVersion": "test_yyds_data2",
      "lastestAdvanceConfigVersion": "test_yyds_data2",
      "currentOnlineConfigVersion": "test_yyds_data1",
      "lastestOnlineConfigVersion": "test_yyds_data1",              
      "description": "this is descrition",
      "queryNode": {
        "number": 1
      },
      "dataNode": {
        "number": 2,
        "partition": 1
      }
    }
  ]
}

Examples

Success response

JSON format

{
  "requestId": "F43E8AB4-419C-5F4C-90D6-615590DFAA3C",
  "result": [
    {
      "name": "hz_pre_vpc_domain_1",
      "description": "CustomDescription",
      "currentAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "latestAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "currentOnlineConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "latestOnlineConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "currentOnlineQueryConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "latestOnlineQueryConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "currentOfflineDictConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "latestOfflineDictConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
      "configUpdateTime": "2024-05-21 16:05:26",
      "status": "running",
      "queryNode": {
        "name": "ha-cn-pl32rf0****_qrs",
        "number": 1,
        "partition": 1
      },
      "dataNode": {
        "name": "general",
        "number": 1,
        "partition": 1
      },
      "createTime": "2024-05-21 16:05:26",
      "config": {
        "key": {
          "key": {
            "name": "ha-cn-pl32rf0****_offline_adv_v1",
            "updateTime": "2024-05-21 16:05:26",
            "desc": "CustomDescription"
          }
        }
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.