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