获取集群信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:GetClusterRunTimeInfo | get |
|
| 无 |
请求语法
GET /openapi/ha3/instances/{instanceId}/cluster-run-time-info HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 ID | ha-cn-pl32rf0**** |
返回参数
返回示例
正确返回
{
"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
}
]
}
]
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2022-01-12 | 新增 OpenAPI | 查看变更详情 |