ListClusters - OpenSearch - Alibaba Cloud Documentation Center

Queries clusters.

Operation description

Method

GET

URI

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:ListClusters	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

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

Request parameters

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

Sample requests

GET /openapi/ha3/instances/ha3_instance_name/clusters

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	id of request	F43E8AB4-419C-5F4C-90D6-615590DFAA3C
result	array<object>	The clusters.
result	object	The list of clusters.
name	string	The cluster name.	ha-cn-7pp2pcna701_qrs
description	string	The description of the cluster.	fzz_test
currentAdvanceConfigVersion	string	The effective advanced configuration version.	" "
latestAdvanceConfigVersion	string	The latest advanced configuration version.	" "
currentOnlineConfigVersion	string	The effective online configuration version.	" "
latestOnlineConfigVersion	string	The latest online configuration version.	" "
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.	" "
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.	"starting"
queryNode	object	The information about Query Result Searcher (QRS) workers.
name	string	The name of the QRS worker.	test_0704
number	integer	The number of QRS workers.	1
partition	integer	The ID of the partition that is stored on the QRS worker.	dt=20211216
dataNode	object	The information about Searcher workers.
name	string	The name of the Searcher worker.	ha-cn-8ed2k7brm05_qrs
number	integer	The number of Searcher workers.	1
partition	integer	The ID of the partition that is stored on the Searcher worker.	dt=20220216
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.

Examples

Sample success responses

JSONformat

{
  "requestId": "F43E8AB4-419C-5F4C-90D6-615590DFAA3C",
  "result": [
    {
      "name": "ha-cn-7pp2pcna701_qrs",
      "description": "fzz_test",
      "currentAdvanceConfigVersion": "\" \"",
      "latestAdvanceConfigVersion": "\" \"",
      "currentOnlineConfigVersion": "\" \"",
      "latestOnlineConfigVersion": "\" \"",
      "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": "\" \"",
      "status": "\"starting\"",
      "queryNode": {
        "name": "test_0704",
        "number": 1,
        "partition": 0
      },
      "dataNode": {
        "name": "ha-cn-8ed2k7brm05_qrs",
        "number": 1,
        "partition": 0
      },
      "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": ""
          }
        }
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-16	The response structure of the API has changed	View Change Details
2022-01-12	Add Operation	View Change Details