调用GetCluster获取某一集群的详细信息_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

获取某一集群的详细信息。

接口说明

方法

GET

URI

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

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

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	ha-cn-0ju2rq6610a
clusterName	string	否	集群名称	bj_vpc_domain_2

请求示例

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

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	集群列表
name	string	集群名称	general
description	string	集群描述	fzz_test
currentAdvanceConfigVersion	string	高级配置生效版本	test_yyds_data1
latestAdvanceConfigVersion	string	高级配置最新版本	test_yyds_data1
currentOnlineConfigVersion	string	在线配置生效版本	test_yyds_data1
latestOnlineConfigVersion	string	在线配置最新版本	test_yyds_data1
configUpdateTime	string	集群更新时间	2021-08-09 00:01:02
status	string	集群的创建状态，有两个取值 NEW(创建中) or PUBLISH(创建完成)	NEW
queryNode	object	查询节点规格
name	string	节点名称	test
number	integer	节点数量。	1
partition	integer	副本数量	2
dataNode	object	数据节点规格
name	string	节点名称	test
number	integer	副本数	1
partition	integer	分片数	2

返回示例

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

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2022-01-12	新增 OpenAPI	看变更集