全部產品
Search

搜尋本產品

    OpenSearch：ListClusters - 擷取叢集列表

    文件中心

    OpenSearch：ListClusters - 擷取叢集列表

    更新時間：Dec 24, 2025

    擷取叢集列表。

    介面說明

    方法

    GET

    URI

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

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    searchengine:ListClusters

    list

    *Instance

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

    		 無 無

    請求文法

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

    路徑參數

    名稱

    類型

    必填

    描述

    樣本值
    instanceId

    string

    是

    執行個體 ID

    ha-cn-pl32rf0****

    請求參數

    名稱

    類型

    必填

    描述

    樣本值

    當前API無需請求參數

    請求樣本

    GET /openapi/ha3/instances/ha3_instance_name/clusters

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    requestId

    string

    請求 ID。

    F43E8AB4-419C-5F4C-90D6-615590DFAA3C
    result

    array<object>

    返回結果。

    array<object>

    叢集列表

    name

    string

    叢集名稱

    hz_pre_vpc_domain_1
    description

    string

    叢集描述

    自訂描述
    currentAdvanceConfigVersion

    string

    進階配置生效版本

    ha-cn-pl32rf0****_offline_adv_v1
    latestAdvanceConfigVersion

    string

    進階配置最新版本

    ha-cn-pl32rf0****_offline_adv_v1
    currentOnlineConfigVersion

    string

    線上配置生效版本

    ha-cn-pl32rf0****_offline_adv_v1
    latestOnlineConfigVersion

    string

    線上配置最新版本

    ha-cn-pl32rf0****_offline_adv_v1
    currentOnlineQueryConfigVersion

    string

    查詢配置生效版本

    ha-cn-pl32rf0****_offline_adv_v1
    latestOnlineQueryConfigVersion

    string

    查詢配置最新版本

    ha-cn-pl32rf0****_offline_adv_v1
    currentOfflineDictConfigVersion

    string

    詞典配置生效版本

    ha-cn-pl32rf0****_offline_adv_v1
    latestOfflineDictConfigVersion

    string

    詞典配置最新版本

    ha-cn-pl32rf0****_offline_adv_v1
    configUpdateTime

    string

    配置更新時間

    2024-05-21 16:05:26
    status

    string

    叢集狀態。取值：-running：運行中-starting：啟動中-stopping：停止中-stopped：已停止

    running
    queryNode

    object

    叢集搜尋節點。

    name

    string

    節點名稱

    ha-cn-pl32rf0****_qrs
    number

    integer

    節點數量。

    1
    partition

    integer

    副本數量

    1
    dataNode

    object

    叢集中的節點資訊

    name

    string

    節點名稱

    general
    number

    integer

    節點數

    1
    partition

    integer

    節點分區 id。

    1
    createTime

    string

    建立時間

    2024-05-21 16:05:26
    config

    object

    配置資訊

    object

    配置資訊

    object

    子配置項資訊

    name

    string

    配置名稱

    ha-cn-pl32rf0****_offline_adv_v1
    updateTime

    string

    更新時間

    2024-05-21 16:05:26
    desc

    string

    描述

    自訂描述

    返回樣本

    正確返回

    {
  "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": "自訂描述"
          }
        }
      }
    }
  ]
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。