GetCluster-阿里云帮助中心

Queries the details of a specific cluster.

Operation description

Method

GET

URI

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

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

get

*Instance

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
clusterName	string	No	The cluster name.	bj_vpc_domain_2

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Request example

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

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	The returned result.
name	string	The cluster name.	bj_vpc_domain_2
description	string	The cluster description.	Custom description
currentAdvanceConfigVersion	string	The effective version of the advanced configuration.	ha-cn-pl32rf0****_offline_adv_v1
latestAdvanceConfigVersion	string	The latest version of the advanced configuration.	ha-cn-pl32rf0****_offline_adv_v1
currentOnlineConfigVersion	string	The effective version of the online configuration.	ha-cn-pl32rf0****_online_adv_v1
latestOnlineConfigVersion	string	The latest version of the online configuration.	ha-cn-pl32rf0****_online_adv_v1
configUpdateTime	string	The time when the cluster was updated. The format is YYYY-MM-DD HH:mm:ss.	2021-08-09 00:01:02
status	string	The creation status of the cluster. Valid values: NEW (creating) and PUBLISH (created).	NEW
queryNode	object	The query node specifications.
name	string	The node name.	ha-cn-pl32rf0****_qrs
number	integer	The number of nodes.	1
partition	integer	The number of replicas.	2
dataNode	object	The data node specifications.
name	string	The node name.	general
number	integer	The number of replicas.	1
partition	integer	The number of shards.	2
createTime	string	The creation time. The format is YYYY-MM-DD HH:mm:ss.	2024-05-21 16:05:26
config	object	The configuration information.
	object	The child configuration item information.
	object	The child configuration item information.
name	string	The configuration name.	ha-cn-pl32rf0****_offline_adv_v1
updateTime	string	The update time in the YYYY-MM-DD HH:mm:ss format.	2024-05-21 16:05:26
desc	string	The description.	自定义描述

Response example

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

Success response

JSON format

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {
    "name": "bj_vpc_domain_2",
    "description": "Custom description",
    "currentAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
    "latestAdvanceConfigVersion": "ha-cn-pl32rf0****_offline_adv_v1",
    "currentOnlineConfigVersion": "ha-cn-pl32rf0****_online_adv_v1",
    "latestOnlineConfigVersion": "ha-cn-pl32rf0****_online_adv_v1",
    "configUpdateTime": "2021-08-09 00:01:02",
    "status": "NEW",
    "queryNode": {
      "name": "ha-cn-pl32rf0****_qrs",
      "number": 1,
      "partition": 2
    },
    "dataNode": {
      "name": "general",
      "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": "自定义描述"
        }
      }
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.