調用DescribeDBClusters API查詢叢集列表-雲資料庫 ClickHouse-阿里雲 -

查詢雲資料庫ClickHouse指定地區的叢集資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:DescribeDBClusters

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。您可以通過調用 DescribeRegions 介面查詢地區 ID。	cn-hangzhou
DBClusterIds	string	否	叢集 ID。說明不配置該參數時，預設查詢所有叢集的資訊。	cc-bp108z124a8o7****
DBClusterDescription	string	否	叢集描述。	cc-bp108z124a8o7****
DBClusterStatus	string	否	叢集狀態，取值說明： Preparing：準備中。 Creating：建立中。 Running：運行中。 Deleting：刪除中。 SCALING_OUT：擴容中。	Running
PageSize	integer	否	每頁記錄數，取值： 30（預設值） 50 100	30
PageNumber	integer	否	頁數。	1
Tag	array<object>	否	標籤。
	object	否	標籤。
Key	string	否	標籤名稱。	department
Value	string	否	標籤的值。	it
ResourceGroupId	string	否	叢集所屬的資源群組 ID。	rg-4690g37929****

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	總記錄數。	1
PageSize	integer	每頁記錄數，取值： 30（預設值） 50 100	30
RequestId	string	請求 ID。	F5178C10-1407-4987-9133-DE4DC9119F75
PageNumber	integer	頁數。	1
DBClusters	object
DBCluster	array<object>	叢集列表。
	array<object>	叢集列表
VpcId	string	VPC ID。	vpc-bp175iuvg8nxqraf2****
DBNodeCount	integer	節點數量。單副本版，取值範圍：1~48。雙副本版，取值範圍：1~24。	2
CreateTime	string	叢集的建立時間，格式：yyyy-MM-ddTHH:mm:ssZ。	2021-10-28T07:24:45Z
PayType	string	付費類型，取值說明： Postpaid：隨用隨付。 Prepaid：預付費（訂用帳戶）。	Postpaid
Tags	object
Tag	array<object>	標籤列表。
	object	標籤。
Key	string	標籤名稱。	department
Value	string	標籤的值。	it
StorageType	string	儲存類型，取值說明： CloudESSD：ESSD PL1 雲端硬碟。 CloudESSD_PL2：ESSD PL2 雲端硬碟。 CloudESSD_PL3：ESSD PL3 雲端硬碟。 CloudEfficiency：高效雲端硬碟。	CloudESSD
Port	integer	HTTP 連接埠號碼。	8123
LockMode	string	叢集的鎖定模式，取值說明： Unlock：正常。 ManualLock：手動觸發鎖定。 LockByExpiration：叢集到期自動鎖定。 LockByRestoration：叢集復原前的自動鎖定。 LockByDiskQuota：叢集空間滿自動鎖定。	Unlock
Bid	string	網站 ID，取值說明： 26842：中國站。 26888：國際站。	26842
IsExpired	string	叢集是否到期，取值說明： true：叢集已到期。 false：叢集未到期。	false
VpcCloudInstanceId	string	VPC 資源 ID。	vpc-bp175iuvg8nxqraf2****
ScaleOutStatus	object	資料搬遷狀態。
Progress	string	資料搬遷百分比。說明僅叢集狀態為 SCALING_OUT 時，返回該參數。	0
Ratio	string	資料搬遷的進度，格式：已搬遷資料量/資料總量。說明僅叢集狀態為 SCALING_OUT 時，返回該參數。	0MB/60469MB
ScaleOutDisableWriteWindows	string	變更配置停寫視窗。	2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00
DBClusterId	string	叢集 ID。	cc-bp108z124a8o7****
ConnectionString	string	VPC 串連地址。	cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com
CommodityCode	string	售賣商品 Code。	clickhouse_go_public_cn
ExpireTime	string	叢集的到期時間，格式：yyyy-MM-ddTHH:mm:ssZ。說明隨用隨付叢集無到期時間，傳回值為空白。	2011-05-30T12:11:4Z
DBNodeStorage	integer	單節點儲存空間，取值範圍：100 GB~32000 GB。說明步長為 100 GB。	100
DBNodeClass	string	叢集規格。單副本版，取值： LS20：大儲存型 20 核 88 GB。 LS40：大儲存型 40 核 176 GB。 LS80：大儲存型 80 核 352 GB。 S8：標準型 8 核 32 GB。 S16：標準型 16 核 64 GB。 S32：標準型 32 核 128 GB。 S64：標準型 64 核 256 GB。 S80：標準型 80 核 384 GB。 S104：標準型 104 核 384 GB。雙副本版，取值： LC20：大儲存型 20 核 88 GB。 LC40：大儲存型 40 核 176 GB。 LC80：大儲存型 80 核 352 GB。 C8：標準型 8 核 32 GB。 C16：標準型 16 核 64 GB。 C32：標準型 32 核 128 GB。 C64：標準型 64 核 256 GB。 C80：標準型 80 核 384 GB。 C104：標準型 104 核 384 GB。單副本版，取值： - S4：4 核 16 GB。 - S8：8 核 32 GB。 S16：16 核 64 GB。 S32：32 核 128 GB。 S64 ：64 核 256 GB。 S104：104 核 384 GB。雙副本版，取值： - C4：4 核 16 GB。 - C8：8 核 32 GB。 - C16：16 核 64 GB。 - C32：32 核 128 GB。 - C64 ：64 核 256 GB。 - C104：104 核 384 GB。	C8
AliUid	string	阿里雲帳號 ID。	140692647406****
LockReason	string	鎖定原因。說明鎖定模式為 Unlock 時，傳回值為空白。	DISK_FULL
RegionId	string	地區 ID。	cn-hangzhou
VSwitchId	string	交換器 ID。	vsw-bp1gzt31twhlo0sa5****
DBClusterStatus	string	叢集狀態，取值說明： Preparing：準備中。 Creating：建立中。 Running：運行中。 Deleting：刪除中。 SCALING_OUT：擴容中。	Running
DBClusterDescription	string	叢集描述。	test
DBClusterNetworkType	string	網路類型，目前只支援 VPC。	VPC
ZoneId	string	可用性區域 ID。	cn-hangzhou-h
Category	string	副本配置，取值說明： Basic：單副本版。 HighAvailability：雙副本版。	Basic
ControlVersion	string	後台管控系統版本號碼，取值說明： v1 v2	v1
ExtStorageType	string	擴充儲存類型，取值說明： CloudSSD：SSD 雲端硬碟。 CloudESSD：ESSD PL1 雲端硬碟。 CloudESSD_PL2：ESSD PL2 雲端硬碟。 CloudESSD_PL3：ESSD PL3 雲端硬碟。 CloudEfficiency：高效雲端硬碟。	CloudESSD
ExtStorageSize	integer	擴充儲存空間。	100GB
ResourceGroupId	string	叢集所屬的資源群組 ID。	rg-4690g37929****
DbVersion	string	叢集核心版本。	23.8

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": 1,
  "DBClusters": {
    "DBCluster": [
      {
        "VpcId": "vpc-bp175iuvg8nxqraf2****",
        "DBNodeCount": 2,
        "CreateTime": "2021-10-28T07:24:45Z",
        "PayType": "Postpaid",
        "Tags": {
          "Tag": [
            {
              "Key": "department",
              "Value": "it"
            }
          ]
        },
        "StorageType": "CloudESSD",
        "Port": 8123,
        "LockMode": "Unlock",
        "Bid": "26842",
        "IsExpired": "false",
        "VpcCloudInstanceId": "vpc-bp175iuvg8nxqraf2****",
        "ScaleOutStatus": {
          "Progress": "0",
          "Ratio": "0MB/60469MB"
        },
        "ScaleOutDisableWriteWindows": "2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00",
        "DBClusterId": "cc-bp108z124a8o7****",
        "ConnectionString": "cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com",
        "CommodityCode": "clickhouse_go_public_cn",
        "ExpireTime": "2011-05-30T12:11:4Z",
        "DBNodeStorage": 100,
        "DBNodeClass": "C8",
        "AliUid": "140692647406****",
        "LockReason": "DISK_FULL",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-bp1gzt31twhlo0sa5****",
        "DBClusterStatus": "Running",
        "DBClusterDescription": "test",
        "DBClusterNetworkType": "VPC",
        "ZoneId": "cn-hangzhou-h",
        "Category": "Basic",
        "ControlVersion": "v1",
        "ExtStorageType": "CloudESSD",
        "ExtStorageSize": 0,
        "ResourceGroupId": "rg-4690g37929****",
        "DbVersion": "23.8"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	An error occurred while processing your request.	系統內部錯誤，請稍後重試
403	Forbidden	User not authorized to operate on the specified resource.	賬戶未被授予操作資源的許可權
503	ServiceUnavailable	An error occurred while processing your request.	系統暫時不可用，請稍後重試

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

變更歷史

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