GetCluster - 获取某一集群的详细信息 - 智能开放搜索 OpenSearch

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

接口说明

方法

GET

URI

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
searchengine:GetCluster	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	ha-cn-pl32rf0****
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	集群名称	bj_vpc_domain_2
description	string	集群描述	自定义描述
currentAdvanceConfigVersion	string	高级配置生效版本	ha-cn-pl32rf0****_offline_adv_v1
latestAdvanceConfigVersion	string	高级配置最新版本	ha-cn-pl32rf0****_offline_adv_v1
currentOnlineConfigVersion	string	在线配置生效版本	ha-cn-pl32rf0****_online_adv_v1
latestOnlineConfigVersion	string	在线配置最新版本	ha-cn-pl32rf0****_online_adv_v1
configUpdateTime	string	集群更新时间	2021-08-09 00:01:02
status	string	集群的创建状态，有两个取值 NEW(创建中) or PUBLISH(创建完成)	NEW
queryNode	object	查询节点规格
name	string	节点名称	ha-cn-pl32rf0****_qrs
number	integer	节点数量。	1
partition	integer	副本数量	2
dataNode	object	数据节点规格
name	string	节点名称	general
number	integer	副本数	1
partition	integer	分片数	2
createTime	string	创建时间	2024-05-21 16:05:26
config	object	配置信息
	object	子配置项信息
	object	子配置项信息
name	string	配置名称	ha-cn-pl32rf0****_offline_adv_v1
updateTime	string	更新时间	2024-05-21 16:05:26
desc	string	描述	自定义描述

返回示例

{
  "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": "bj_vpc_domain_2",
    "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": "自定义描述"
        }
      }
    }
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-05-16	OpenAPI 返回结构发生变更	查看变更详情
2022-01-12	新增 OpenAPI	查看变更详情