DescribeDBClusters - 查詢叢集列表 -

查詢PolarDB叢集列表或被RAM授權的叢集列表詳情。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeDBClusters

list

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。說明您可以通過介面 DescribeRegions 查看可用的地區。	cn-hangzhou
DBClusterIds	string	否	叢集 ID。多個叢集 ID 間用英文逗號（,）隔開。	pc-****************
DBClusterDescription	string	否	叢集描述，可模糊查詢。	pc-****************
ConnectionString	string	否	資料庫連接地址。	********.rwlb.polardb-pg-public.rds.aliyuncs.com
DBClusterStatus	string	否	叢集狀態，取值範圍請參見叢集狀態表。	Running
DBType	string	否	資料庫類型，取值範圍如下： MySQL PostgreSQL Oracle	MySQL
DescribeType	string	否	列表查詢方式。取值為 Simple，表示簡略模式，僅返回叢集的基本中繼資料資訊。說明如果未填寫該參數，則預設為詳細模式，返回叢集的詳細資料。	Simple
DBVersion	string	否	資料庫版本。	5.6
RecentCreationInterval	integer	否	篩選最近 N 天建立的叢集。取值範圍：0~15。	7
RecentExpirationInterval	integer	否	篩選 N 天后到期的叢集。取值範圍：0~15。	6
Expired	boolean	否	是否叢集已到期。取值範圍如下： true false	true
PageSize	integer	否	每頁記錄數，取值為 30、50 或 100。預設值為 30。	30
PageNumber	integer	否	頁碼，取值為大於 0 且不超過整數資料類型的最大值，預設值為 1。	10
ResourceGroupId	string	否	資源群組 ID。	rg-**********
Tag	array<object>	否	標籤列表。
	object	否
Key	string	否	標籤鍵，可以根據標籤過濾叢集列表。最多 20 對標籤，各個標籤對的數字 n 必須不同，且必須是從 1 開始的連續整數。Tag.n.Key 對應的值為 Tag.n.Value。說明最多支援 64 個字元，不能以`aliyun`、`acs:`、`http://`或者`https://`開頭。	MySQL
Value	string	否	標籤鍵對應的標籤值。說明最多支援 64 個字元，不能以`aliyun`、`acs:`、`http://`或者`https://`開頭。	5.6
PayType	string	否	付費類型，取值範圍如下： Postpaid：隨用隨付 Prepaid：預付費（訂用帳戶）	Postpaid
DBNodeIds	string	否	節點 ID。支援傳入多個節點 ID，多個 ID 間用英文逗號（,）分隔。	pi-***************

返回參數

名稱	類型	描述	樣本值
	object
TotalRecordCount	integer	總記錄數。	16
PageRecordCount	integer	本頁叢集數量。	5
RequestId	string	請求 ID。	9B7BFB11-C077-4FE3-B051-F69CEB******
PageNumber	integer	頁數。	12
Items	object
DBCluster	array<object>	叢集列表。
	array<object>
VpcId	string	專用網路 ID。	vpc-****************
VswitchId	string	虛擬交換器 ID。	vsw-***************
ExpireTime	string	叢集到期時間。說明僅付費方式為 Prepaid（訂用帳戶）的叢集會返回具體參數值，Postpaid（隨用隨付）叢集則返回空值。	2020-11-14T16:00:00Z
Expired	string	叢集是否到期。取值範圍： true false 說明僅付費方式為 Prepaid（訂用帳戶）的叢集支援返該參數。	false
DBNodeNumber	integer	節點數量。	2
CreateTime	string	建立時間。	2020-08-14T05:58:42Z
PayType	string	付費類型。取值範圍： Postpaid：隨用隨付。 Prepaid：訂用帳戶（預付費）。	Prepaid
StoragePayType	string	儲存計費類型。取值範圍： Postpaid：按容量計費（隨用隨付）。 Prepaid：按空間計費（訂用帳戶）。	Prepaid
ServerlessType	string	Serverless 類型。返回 AgileServerless 表示當前叢集是 Serverless 叢集，返回空值表示當前叢集是普通叢集。	AgileServerless
StrictConsistency	string	叢集是否開啟了多可用性區域資料強一致。取值範圍： ON：表示開啟了多可用性區域資料強一致，適用於標準版 3AZ 情境。 OFF：表示未開啟多可用性區域資料強一致。	ON
DBNodeClass	string	節點規格。	polar.mysql.x4.large
Tags	object
Tag	array<object>	標籤列表。
	object
Key	string	標籤鍵。	MySQL
Value	string	標籤值。	5.6
DBType	string	資料庫類型。	MySQL
LockMode	string	叢集的鎖定狀態，取值範圍如下： Unlock：正常。 ManualLock：手動觸發鎖定。 LockByExpiration：叢集到期自動鎖定。	Unlock
DBNodes	object
DBNode	array<object>	節點列表。
	object
DBNodeClass	string	節點規格。	polar.mysql.x4.large
ZoneId	string	可用性區域 ID。	cn-hangzhou-i
DBNodeRole	string	節點角色，取值範圍如下： Writer：主節點。 Reader：唯讀節點。 ColumnReader：列存唯讀節點。 AI：AI 節點。	Reader
DBNodeId	string	節點 ID。	pi-****************
RegionId	string	地區 ID。	cn-hangzhou
Serverless	string	當前節點是否開啟了 Serverless 功能。返回 ON 表示開啟了 Serverless 功能。返回空值表示沒有開啟 Serverless 功能。	ON
ImciSwitch	string	是否開啟列存索引。取值範圍如下： ON：開啟 OFF：關閉	OFF
HotReplicaMode	string	是否開啟熱備。取值範圍如下： ON：開啟 OFF：關閉	OFF
RegionId	string	地區 ID。	cn-hangzhou
DeletionLock	integer	叢集刪除的保護狀態，取值範圍如下： 0：未鎖定。 1：鎖定。說明鎖定狀態時，不可以刪除叢集。	0
DBVersion	string	資料庫版本。	5.6
DBClusterId	string	叢集 ID。	pc-****************
DBClusterStatus	string	叢集狀態。	Running
ResourceGroupId	string	資源群組 ID。	rg-************
SearchStorageUsed	integer
StorageSpace	integer	按空間計費（訂用帳戶）的儲存空間。單位：Byte。	50
DBClusterNetworkType	string	叢集的網路類型。	VPC
DBClusterDescription	string	叢集描述。	GDN-1
ZoneId	string	可用性區域 ID。	cn-hangzhou-i
Engine	string	叢集引擎。	POLARDB
Category	string	叢集系列，目前支援如下系列： Normal：叢集版 Basic：單節點 Archive：高壓縮引擎（X-Engine） NormalMultimaster：多主叢集（庫表）	Normal
AiType	string	ai 節點資訊狀態。取值範圍如下： SearchNode：搜尋節點 DLNode：ai 節點枚舉值： SearchNode\|DLNode : Both DLNode : DLNode SearchNode : SearchNode	SearchNode
CpuCores	string	CPU 核心數。單位：個。	1
MemorySize	string	節點記憶體大小，單位：MB。	2048
RemoteMemorySize	string	遠端記憶體大小，單位：MB。	3612
StorageType	string	企業版儲存類型取值如下： HighPerformance：對應 PSL5 Standard：對應 PSL4 標準版儲存類型取值如下： essdpl0 essdpl1 essdpl2 essdpl3 essdautopl	essdautopl
HotStandbyCluster	string	儲存熱備叢集。取值範圍如下： ON：開啟 OFF：關閉	OFF
SubCategory	string	計算節點的規格類型，取值範圍如下： Exclusive：獨享規格 General：通用規格	Exclusive
StorageUsed	integer	叢集已經使用的儲存用量，單位為 Byte。	3009413120

樣本

正常返回樣本

JSON格式

{
  "TotalRecordCount": 16,
  "PageRecordCount": 5,
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******",
  "PageNumber": 12,
  "Items": {
    "DBCluster": [
      {
        "VpcId": "vpc-****************",
        "VswitchId": "vsw-***************",
        "ExpireTime": "2020-11-14T16:00:00Z",
        "Expired": "false",
        "DBNodeNumber": 2,
        "CreateTime": "2020-08-14T05:58:42Z",
        "PayType": "Prepaid",
        "StoragePayType": "Prepaid",
        "ServerlessType": "AgileServerless",
        "StrictConsistency": "ON",
        "DBNodeClass": "polar.mysql.x4.large",
        "Tags": {
          "Tag": [
            {
              "Key": "MySQL",
              "Value": "5.6"
            }
          ]
        },
        "DBType": "MySQL",
        "LockMode": "Unlock",
        "DBNodes": {
          "DBNode": [
            {
              "DBNodeClass": "polar.mysql.x4.large",
              "ZoneId": "cn-hangzhou-i",
              "DBNodeRole": "Reader",
              "DBNodeId": "pi-****************",
              "RegionId": "cn-hangzhou",
              "Serverless": "ON",
              "ImciSwitch": "OFF",
              "HotReplicaMode": "OFF"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "DeletionLock": 0,
        "DBVersion": "5.6",
        "DBClusterId": "pc-****************",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-************",
        "SearchStorageUsed": 0,
        "StorageSpace": 50,
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "GDN-1",
        "ZoneId": "cn-hangzhou-i",
        "Engine": "POLARDB",
        "Category": "Normal",
        "AiType": "SearchNode",
        "CpuCores": "1",
        "MemorySize": "2048",
        "RemoteMemorySize": "3612",
        "StorageType": "essdautopl",
        "HotStandbyCluster": "OFF",
        "SubCategory": "Exclusive",
        "StorageUsed": 3009413120
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	指定的參數RegionId無效
400	NumberExceed.Tags	The Tags parameter's number is exceed.	tags參數的數目超過。
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	指定的參數PageSize無效
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	指定的參數PageNumber無效
400	InvalidRecentCreationInterval.Malformed	The specified parameter RecentCreationInterval is not valid.	指定的參數RecentCreationInterval無效。
400	InvalidRecentExpirationInterval.Malformed	The specified parameter RecentExpirationInterval is not valid.	指定的參數RecentExpirationInterval無效。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	由於某些未知錯誤、異常或失敗，請求處理失敗。
404	DBTypeOrDBVersion.Malformed	The specified DBType does not match DBVersion.	指定的DBType與DBVersion不匹配。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	由於伺服器臨時故障，請求失敗。

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

變更歷史

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