文档

ListClusters - 获取集群列表

更新时间:

获取集群列表。

接口说明

方法

GET

URI

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:ListClustersList
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

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

请求参数

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

实例 ID

ha-cn-zvp2jlr2g03

请求示例

GET /openapi/ha3/instances/ha3_instance_name/clusters

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

id of request

F43E8AB4-419C-5F4C-90D6-615590DFAA3C
resultobject []

集群列表

namestring

集群名称

ha-cn-7pp2pcna701_qrs
descriptionstring

集群描述

fzz_test
currentAdvanceConfigVersionstring

高级配置生效版本

" "
latestAdvanceConfigVersionstring

高级配置最新版本

" "
currentOnlineConfigVersionstring

在线配置生效版本

" "
latestOnlineConfigVersionstring

在线配置最新版本

" "
currentOnlineQueryConfigVersionstring

查询配置生效版本

latestOnlineQueryConfigVersionstring

查询配置最新版本

currentOfflineDictConfigVersionstring

词典配置生效版本

latestOfflineDictConfigVersionstring

词典配置最新版本

configUpdateTimestring

配置更新时间

" "
statusstring

集群状态。取值:-running:运行中-starting:启动中-stopping:停止中-stopped:已停止

"starting"
queryNodeobject

集群搜索节点。

namestring

节点名称

test_0704
numberinteger

节点数量。

1
partitioninteger

副本数量

dt=20211216
dataNodeobject

集群中的节点信息

namestring

节点名称

ha-cn-8ed2k7brm05_qrs
numberinteger

节点数

1
partitioninteger

节点分区 id。

dt=20220216

返回示例

正确返回

{
  "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": {
        "number": 1
      },
      "dataNode": {
        "number": 2,
        "partition": 1
      },      
    },
    {
      "name": "cluster2",
      "configUpdateTime": "2021-08-09 00:01:02",
      "currentAdvanceConfigVersion": "test_yyds_data2",
      "lastestAdvanceConfigVersion": "test_yyds_data2",
      "currentOnlineConfigVersion": "test_yyds_data1",
      "lastestOnlineConfigVersion": "test_yyds_data1",              
      "description": "this is descrition",
      "queryNode": {
        "number": 1
      },
      "dataNode": {
        "number": 2,
        "partition": 1
      }
    }
  ]
}

示例

正常返回示例

JSON格式

{
  "requestId": "F43E8AB4-419C-5F4C-90D6-615590DFAA3C",
  "result": [
    {
      "name": "ha-cn-7pp2pcna701_qrs",
      "description": "fzz_test",
      "currentAdvanceConfigVersion": "\" \"",
      "latestAdvanceConfigVersion": "\" \"",
      "currentOnlineConfigVersion": "\" \"",
      "latestOnlineConfigVersion": "\" \"",
      "currentOnlineQueryConfigVersion": "",
      "latestOnlineQueryConfigVersion": "",
      "currentOfflineDictConfigVersion": "",
      "latestOfflineDictConfigVersion": "",
      "configUpdateTime": "\" \"",
      "status": "\"starting\"",
      "queryNode": {
        "name": "test_0704",
        "number": 1,
        "partition": 0
      },
      "dataNode": {
        "name": "ha-cn-8ed2k7brm05_qrs",
        "number": 1,
        "partition": 0
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-01-12新增 OpenAPI看变更集
  • 本页导读 (0)
文档反馈