全部产品
Search
文档中心

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

更新时间:Jul 17, 2024

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

接口说明

方法

GET

URI

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

调试

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

授权信息

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

请求语法

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

请求参数

名称类型必填描述示例值
instanceIdstring

实例 ID

ha-cn-pl32rf0****
clusterNamestring

集群名称

bj_vpc_domain_2

请求示例

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

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

E7B7D598-B080-5C8E-AA35-D43EC0D5F886
resultobject

返回结果。

namestring

集群名称

bj_vpc_domain_2
descriptionstring

集群描述

自定义描述
currentAdvanceConfigVersionstring

高级配置生效版本

ha-cn-pl32rf0****_offline_adv_v1
latestAdvanceConfigVersionstring

高级配置最新版本

ha-cn-pl32rf0****_offline_adv_v1
currentOnlineConfigVersionstring

在线配置生效版本

ha-cn-pl32rf0****_online_adv_v1
latestOnlineConfigVersionstring

在线配置最新版本

ha-cn-pl32rf0****_online_adv_v1
configUpdateTimestring

集群更新时间

2021-08-09 00:01:02
statusstring

集群的创建状态,有两个取值 NEW(创建中) or PUBLISH(创建完成)

NEW
queryNodeobject

查询节点规格

namestring

节点名称

ha-cn-pl32rf0****_qrs
numberinteger

节点数量。

1
partitioninteger

副本数量

2
dataNodeobject

数据节点规格

namestring

节点名称

general
numberinteger

副本数

1
partitioninteger

分片数

2
createTimestring

创建时间

2024-05-21 16:05:26
configobject

配置信息

object

子配置项信息

object

子配置项信息

namestring

配置名称

ha-cn-pl32rf0****_offline_adv_v1
updateTimestring

更新时间

2024-05-21 16:05:26
descstring

描述

自定义描述

返回示例

{
  "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-16OpenAPI 返回结构发生变更查看变更详情
2022-01-12新增 OpenAPI查看变更详情