ListClusters - OpenSearch - Alibaba Cloud Documentation Center

Queries the list of clusters.

Operation Description

Method

GET

URI

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

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

Sample requests

GET /openapi/ha3/instances/ha3_instance_name/clusters

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	id of request	F43E8AB4-419C-5F4C-90D6-615590DFAA3C
result	array	The list of clusters.
	object	The list of clusters.
name	string	The name of the cluster.	ha-cn-7pp2pcna701_qrs
description	string	The description of the cluster.	fzz_test
currentAdvanceConfigVersion	string	The effective advanced version.	" "
latestAdvanceConfigVersion	string	The latest advanced configuration version.	" "
currentOnlineConfigVersion	string	The effective online configuration version.	" "
latestOnlineConfigVersion	string	The latest online configuration version.	" "
configUpdateTime	string	The time when the configuration was updated.	" "
status	string	The status of the cluster. Valid values: running, starting, stopping, and stopped. running indicates the cluster is running, starting indicates the cluster is starting, stopping indicates the cluster is stopping, and stopped indicates the cluster has stopped.	"starting"
queryNode	object	The query node of the cluster.
name	string	The name of the node.	test_0704
number	integer	The number of nodes.	1
partition	integer	The number o replicas.	dt=20211216
dataNode	object	The information about the node in the cluster.
name	string	The name of the node.	ha-cn-8ed2k7brm05_qrs
number	integer	The number of nodes.	1
partition	integer	The partition ID of the node.	dt=20220216

Sample responses

Success responses

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

Sample success responses

JSONformat

{
  "requestId": "F43E8AB4-419C-5F4C-90D6-615590DFAA3C",
  "result": [
    {
      "name": "ha-cn-7pp2pcna701_qrs",
      "description": "fzz_test",
      "currentAdvanceConfigVersion": "\" \"",
      "latestAdvanceConfigVersion": "\" \"",
      "currentOnlineConfigVersion": "\" \"",
      "latestOnlineConfigVersion": "\" \"",
      "currentOnlineQueryConfigVersion": "",
      "latestOnlineQueryConfigVersion": "",
      "currentOfflineDictConfigVersion": "",
      "latestOfflineDictConfigVersion": "",
      "configUpdateTime": "\" \"",
      "status": "\"starting\"",
      "queryNode": {
        "name": "test_0704",
        "number": 1,
        "partition": 0
      },
      "dataNode": {
        "name": "ha-cn-8ed2k7brm05_qrs",
        "number": 1,
        "partition": 0
      }
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-01-12	Add Operation