GetClusterRunTimeInfo - 获取集群信息

获取集群信息。

接口说明

方法

GET

URI

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

调试

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

调试

授权信息

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

请求语法

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

请求参数

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

实例 ID

ha-cn-2r42ncw4102

请求示例

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

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

E45380E8-994A-5402-9806-F114B3295FCF
resultobject []

结果集

clusterNamestring

集群名称

vpc_hz_domain_1
queryNodeobject

查询结点信息

serviceStatusobject

服务状态

namestring

集群名称

ha-cn-c4d2rq7nt04_qrs
totalSizeinteger

总大小

100
doneSizeinteger

完成大小

100
donePercentinteger

进度

100
dataNodesobject []

数据结点信息

serviceStatusobject

服务状态。

namestring

名称

ha-cn-0ju2s170b03_qrs
totalSizeinteger

集群总节点数

100
doneSizeinteger

集群处理中的节点数。

100
donePercentinteger

总共完成进度

100
configStatusListobject []

配置状态列表

configUpdateTimestring

集群更新时间

""
namestring

集群名称

test_0704
totalSizeinteger

总大小

0
doneSizeinteger

完成大小

1
donePercentinteger

总共完成的进度

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": "ha-cn-c4d2rq7nt04_qrs",
          "totalSize": 100,
          "doneSize": 100,
          "donePercent": 100
        },
        "configStatusList": [
          {
            "configUpdateTime": "\" \"",
            "name": "ha-cn-zvp2qr1sk01_qrs",
            "totalSize": 6,
            "doneSize": 100,
            "donePercent": 100
          }
        ]
      },
      "dataNodes": [
        {
          "dataStatusList": [
            {
              "docSize": 2,
              "fullVersion": 123423,
              "incVersion": 123423,
              "incUpdateTime": "\"\"",
              "fullUpdateTime": "\" \"",
              "indexConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 0
              },
              "advanceConfigInfo": {
                "configMetaName": "index_meta_name",
                "version": 1
              },
              "lackMemWorker": [
                "\"\""
              ],
              "deployFailedWorker": [
                "\"\""
              ],
              "lackDiskWorker": [
                "\"\""
              ],
              "errorMsg": "0A3B1C48006A6C0905F6375F4821EB50",
              "indexSize": 100,
              "name": "ha-cn-c4d2rq7nt04_qrs",
              "totalSize": 1,
              "doneSize": 100,
              "donePercent": 100
            }
          ],
          "serviceStatus": {
            "name": "ha-cn-0ju2s170b03_qrs",
            "totalSize": 100,
            "doneSize": 100,
            "donePercent": 100
          },
          "configStatusList": [
            {
              "configUpdateTime": "\"\"",
              "name": "test_0704",
              "totalSize": 0,
              "doneSize": 1,
              "donePercent": 100
            }
          ]
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI
阿里云首页 智能开放搜索 OpenSearch 相关技术圈