GetCluster - OpenSearch - Alibaba Cloud Documentation Center

Queries the details of a cluster.

Operation description

Method

GET

URI

/openapi/ha3/instance/{instanceId}/clusters/{clusterName}

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:GetCluster	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-0ju2rq6610a
clusterName	string	No	The name of the cluster	bj_vpc_domain_2

Sample requests

GET /openapi/ha3/instance/ha_name_example/clusters/my_cluster

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	The clusters.
name	string	The cluster name.	general
description	string	The description of the cluster.	fzz_test
currentAdvanceConfigVersion	string	The effective advanced configuration version.	test_yyds_data1
latestAdvanceConfigVersion	string	The latest advanced configuration version.	test_yyds_data1
currentOnlineConfigVersion	string	The effective online configuration version.	test_yyds_data1
latestOnlineConfigVersion	string	The latest online configuration version.	test_yyds_data1
configUpdateTime	string	The time when the cluster was updated.	2021-08-09 00:01:02
status	string	The creation status of the cluster. Valid values: NEW and PUBLISH. NEW indicates that the cluster is being created. PUBLISH indicates that the cluster is created.	NEW
queryNode	object	The specifications of Query Result Searcher (QRS) workers.
name	string	The name of the QRS worker.	test
number	integer	The number of nodes.	1
partition	integer	The number of replicas.	2
dataNode	object	The specifications of Searcher workers.
name	string	The name of the Searcher worker.	test
number	integer	The number of replicas.	1
partition	integer	The number of partitions.	2
createTime	string	The time when the cluster was created.	2024-05-21 16:05:26
config	object	The configuration information.
	object	The information about child configuration items.
	object	The information about the child configuration item.
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.	Custom description

Sample 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": {
      "name":"ha-cn-0ju2iimcu07_qrs",
      "number": 1
    },
    "dataNode": {
      "name":"general",
      "number": 2,
      "partition": 1
    }    
  }
}

Examples

Sample success responses

JSONformat

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {
    "name": "general",
    "description": "fzz_test",
    "currentAdvanceConfigVersion": "test_yyds_data1",
    "latestAdvanceConfigVersion": "test_yyds_data1",
    "currentOnlineConfigVersion": "test_yyds_data1",
    "latestOnlineConfigVersion": "test_yyds_data1",
    "configUpdateTime": "2021-08-09 00:01:02",
    "status": "NEW",
    "queryNode": {
      "name": "test",
      "number": 1,
      "partition": 2
    },
    "dataNode": {
      "name": "test",
      "number": 1,
      "partition": 2
    },
    "createTime": "2024-05-21 16:05:26",
    "config": {
      "key": {
        "key": {
          "name": "ha-cn-pl32rf0****_offline_adv_v1\n",
          "updateTime": "2024-05-21 16:05:26",
          "desc": "Custom description\n"
        }
      }
    }
  }
}

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