GetClusterRunTimeInfo - 获取集群信息 - 智能开放搜索 OpenSearch

获取集群信息。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/cluster-run-time-info

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

searchengine:GetClusterRunTimeInfo

get

*Instance

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

无

请求语法

GET /openapi/ha3/instances/{instanceId}/cluster-run-time-info HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	ha-cn-pl32rf0****

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

请求示例

GET /openapi/ha3/instances/ose-test1/cluster-run-time-info

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID。	E45380E8-994A-5402-9806-F114B3295FCF
result	array<object>	返回结果。
	array<object>	集群运行时长信息。
clusterName	string	集群名称	vpc_hz_domain_1
queryNode	object	查询结点信息
serviceStatus	object	服务状态
name	string	集群名称	vpc_hz_domain_1
totalSize	integer	总大小	100
doneSize	integer	完成大小	100
donePercent	integer	进度	100
configStatusList	array<object>	配置状态列表。
	object	配置状态列表。
configUpdateTime	string	集群更新时间	2024-05-21 16:05:26
name	string	集群名称	vpc_hz_domain_1
totalSize	integer	总大小	6
doneSize	integer	完成大小	100
donePercent	integer	进度	100
dataNodes	array<object>	数据结点信息
	array<object>	集群节点信息。
dataStatusList	array<object>	节点数据列表。
	array<object>	节点数据列表。
docSize	integer	存储容量 (单位:GB)	2
fullVersion	integer	全量版本	1718846192
incVersion	integer	增量版本	1718846192
incUpdateTime	string	增量更新时间	2024-05-21 16:05:26
fullUpdateTime	string	全量更新时间	2024-05-21 16:05:26
indexConfigInfo	object	索引配置
configMetaName	string	索引配置名称	index_meta_name
version	integer	索引模板的版本。	1.0.0
advanceConfigInfo	object	高级配置信息
configMetaName	string	索引配置名称	index_meta_name
version	integer	版本号。	1.0
lackMemWorker	array	因缺少内存而失败的 worker 的 name
	string	失败的 worker 的 name	test-fail-worker
deployFailedWorker	array	因部署失败而失败的 worker 的 name
	string	失败的 worker 的 name	test-fail-worker
lackDiskWorker	array	因缺少磁盘而失败的 worker 的 name
	string	失败的 worker 的 name	test-fail-worker
errorMsg	string	错误信息。	0A3B1C48006A6C0905F6375F4821EB50
indexSize	integer	索引长度	100
name	string	节点名称	ha-cn-pl32rf0****_qrs
totalSize	integer	总大小	1
doneSize	integer	完成大小	100
donePercent	integer	总共完成的进度	100
serviceStatus	object	服务状态。
name	string	名称	ha-cn-pl32rf0****_qrs
totalSize	integer	集群总节点数	100
doneSize	integer	集群处理中的节点数。	100
donePercent	integer	总共完成进度	100
configStatusList	array<object>	配置状态列表
	object	响应体
configUpdateTime	string	集群更新时间	2024-05-21 16:05:26
name	string	集群名称	test_0704
totalSize	integer	总大小	0
doneSize	integer	完成大小	1
donePercent	integer	总共完成的进度	100

返回示例

正确返回

{
  "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",
  "result": [
    {
      "clusterName": "",
      "queryNode": {
        "serviceStatus": {
          "name": "service_name",
          "totalSize": 1,
          "doneSize": 1,
          "donePercent": 100
        },
        "configStatusList": [
          {
            "name": "default",
            "totalSize": 1,
            "doneSize": 1,
            "donePercent": 100,
            "configUpdateTime": ""
          }
        ]
      },
      "dataNodes": [
        {
          "serviceStatus": {
            "name": "service_name",
            "totalSize": 1,
            "doneSize": 1,
            "donePercent": 100
          },
          "configStatusList": [
            {
              "name": "default",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "configUpdateTime": ""
            }
          ],
          "dataStatusList": [
            {
              "name": "index1",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "docSize": 123423,
              "fullVersion": 123423,
              "incVersion": 123423,
              "incUpdateTime": "",
              "fullUpdateTime": "",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 13241234
              },
              "advanceConfigInfo": {
                "configMetaName": "advance_meta_name",
                "version": 13241234
              },
              "lackMemWorker": [
                "worker1",
                "worker2"
              ],
              "deployFailedWorker": [
                "worker3",
                "worker4"
              ],
              "lackDiskWorker": [
                "worker5",
                "worker6"
              ],
              "errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"
            },
            {
              "name": "index1",
              "totalSize": 1,
              "doneSize": 1,
              "donePercent": 100,
              "docSize": 123423,
              "fullVersion": 123423,
              "incVersion": 123423,
              "incUpdateTime": "",
              "fullUpdateTime": "",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 13241234
              },
              "advanceConfigInfo": {
                "configMetaName": "advance_meta_name",
                "version": 13241234
              },
              "lackMemWorker": [
                "worker1",
                "worker2"
              ],
              "deployFailedWorker": [
                "worker3",
                "worker4"
              ],
              "lackDiskWorker": [
                "worker5",
                "worker6"
              ],
              "errorMsg": "lackMemWorker/deployFailedWorker/lackDiskWorker"
            }
          ]
        }
      ]
    }
  ]
}

示例

正常返回示例

JSON格式

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": [
    {
      "clusterName": "vpc_hz_domain_1",
      "queryNode": {
        "serviceStatus": {
          "name": "vpc_hz_domain_1\n",
          "totalSize": 100,
          "doneSize": 100,
          "donePercent": 100
        },
        "configStatusList": [
          {
            "configUpdateTime": "2024-05-21 16:05:26",
            "name": "vpc_hz_domain_1\n",
            "totalSize": 6,
            "doneSize": 100,
            "donePercent": 100
          }
        ]
      },
      "dataNodes": [
        {
          "dataStatusList": [
            {
              "docSize": 2,
              "fullVersion": 1718846192,
              "incVersion": 1718846192,
              "incUpdateTime": "2024-05-21 16:05:26",
              "fullUpdateTime": "2024-05-21 16:05:26",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 0
              },
              "advanceConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 1
              },
              "lackMemWorker": [
                "test-fail-worker\n"
              ],
              "deployFailedWorker": [
                "test-fail-worker\n"
              ],
              "lackDiskWorker": [
                "test-fail-worker"
              ],
              "errorMsg": "0A3B1C48006A6C0905F6375F4821EB50",
              "indexSize": 100,
              "name": "ha-cn-pl32rf0****_qrs",
              "totalSize": 1,
              "doneSize": 100,
              "donePercent": 100
            }
          ],
          "serviceStatus": {
            "name": "ha-cn-pl32rf0****_qrs",
            "totalSize": 100,
            "doneSize": 100,
            "donePercent": 100
          },
          "configStatusList": [
            {
              "configUpdateTime": "2024-05-21 16:05:26",
              "name": "test_0704",
              "totalSize": 0,
              "doneSize": 1,
              "donePercent": 100
            }
          ]
        }
      ]
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。