透過 ListClusterNames API 查詢 HA3 集群名稱 - 開放搜尋

介面說明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/cluster-names

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ListClusterNames

list

*Instance

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

無

請求文法

GET /openapi/ha3/cluster-names HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

請求樣本

GET /openapi/ha3/instances/ha3_instance_name/cluster-names

返回參數

名稱	類型	描述	樣本值
	object
requestId	string	請求 ID。	F6E3D968-529C-5C40-AFDD-133A8B8FD930
result	object	返回結果。
name	string	叢集名稱。	hz_pre_vpc_domain_1
description	string	叢集描述。	自訂描述
id	integer	叢集 ID。	25030

返回樣本

正確返回

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": [
    {
      "name":"pre",
      "description":"pre 機房",
      "id": 1,
    }
  ]
}

樣本

正常返回樣本

JSON格式

{
  "requestId": "F6E3D968-529C-5C40-AFDD-133A8B8FD930",
  "result": {
    "name": "hz_pre_vpc_domain_1",
    "description": "自訂描述",
    "id": 25030
  }
}

錯誤碼

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

變更歷史

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