DescribeDBClusters - 查詢執行個體列表 - AnalyticDB

查詢數倉版叢集列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

adb:DescribeDBClusters

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。說明您可以調用 DescribeRegions 介面查看可用地區的地區 ID。	cn-hangzhou
DBClusterIds	string	否	叢集 ID。說明您可以輸入上述地區中任意的叢集 ID。	am-bp1r053byu48p****
DBClusterDescription	string	否	叢集描述。不能以`http://`或者`https://`開頭。長度為 2~256 個字元。	test
DBClusterStatus	string	否	叢集狀態，取值說明： Preparing：準備中 Creating：建立中 Restoring：備份恢複中 Running：運行中 Deleting：刪除中 ClassChanging：變更配置中 NetAddressCreating：建立網路中 NetAddressDeleting：刪除網路中	Running
PageSize	integer	否	每頁記錄數，取值： 30（預設值） 50 100	30
PageNumber	integer	否	頁碼，取值為大於 0 且不超過整數資料類型的最大值。預設值為 1。	1
ResourceGroupId	string	否	資源群組 ID。	rg-4690g37929XXXX
Tag	array<object>	否	標籤資訊列表。
	object	否	列表詳情。
Key	string	否	標籤鍵，可以根據標籤過濾叢集列表。最多 20 對標籤，各個標籤對的數字 n 必須不同，且必須是從 1 開始的連續整數。`Tag.N.Key`對應的值為`Tag.N.Value`。說明最多支援 64 個字元，不能以`aliyun`、`acs:`、`http://`或者`https://`開頭。	tag1
Value	string	否	標籤值，可以根據標籤過濾叢集列表。最多 20 對標籤，各個標籤對的數字 n 必須不同，且必須是從 1 開始的連續整數。`Tag.N.Key`對應的值為`Tag.N.Value`。說明最多支援 64 個字元，不能以`aliyun`、`acs:`、`http://`或者`https://`開頭。	test1
DBVersion	string	否	叢集版本，固定取值為3.0。	3.0
DBClusterVersion	string	否

返回參數

名稱	類型	描述	樣本值
	object	列表詳情。
TotalCount	integer	總記錄數。	1
PageSize	integer	每頁記錄數。	30
RequestId	string	請求 ID。	D65A809F-34CE-4550-9BC1-0ED21ETG380
PageNumber	integer	頁碼。	1
Items	object
DBCluster	array<object>	叢集資訊列表。
	array<object>	列表詳情。
DtsJobId	string	DTS 同步任務 ID。僅 MySQL 分析執行個體會返回該參數。	dtsb1578j90XXXX
DBNodeCount	integer	節點群組個數。	1
Expired	string	叢集是否到期。取值說明： true：已到期。 false：未到期。	false
CreateTime	string	叢集建立時間，UTC 時間，格式為yyyy-MM-ddTHH:mm:ssZ，例如2021-04-01T09:50:18Z。	2021-04-01T09:50:18Z
PayType	string	叢集付費類型，取值說明： Postpaid：隨用隨付（即後付費）。 Prepaid：訂用帳戶（即預付費）。	Postpaid
DiskType	string	叢集的磁碟類型，取值說明： local_ssd：本地磁碟。 cloud：普通雲端硬碟。 cloud_ssd：SSD 雲端硬碟。 cloud_efficiency：高效雲端硬碟。 cloud_essd0：PL0 等級的 ESSD 雲端硬碟。 cloud_essd：PL1 等級的 ESSD 雲端硬碟。 cloud_essd2：PL2 等級的 ESSD 雲端硬碟。 cloud_essd3：PL3 等級的 ESSD 雲端硬碟。說明更多關於 ESSD 雲端硬碟的詳情，請參見 ESSD 雲端硬碟規格。	cloud_essd
Tags	object
Tag	array<object>	標籤資訊列表。
	object	列表詳情。
Key	string	標籤鍵。說明您可以調用 TagResources 介面為目的地組群建立標籤。	tag1
Value	string	標籤值。	test1
Mode	string	叢集模式，取值說明： flexible：彈性模式。 reserver：預留模式。說明更多關於叢集模式的介紹，請參見產品系列。	flexible
Port	string	叢集連接埠號碼，預設為 3306。	3306
LockMode	string	叢集的鎖定模式，取值說明： Unlock：正常（即未鎖定）。 ManualLock：手動觸發鎖定。 LockByExpiration：叢集到期自動鎖定。 LockByRestoration：叢集復原前自動鎖定。 LockByDiskQuota：叢集中空間滿（即資料佔用的儲存空間已到達上限水位的 90%）自動鎖定。	Unlock
StorageResource	string	彈性模式用的儲存資源規格，用於資料讀寫，增加該資源能提高叢集讀寫能力。	8Core32GB
ExecutorCount	string	彈性模式下叢集使用的計算節點數量。	1
DBClusterId	string	叢集 ID。	am-bp163885f8q21****
ConnectionString	string	叢集的公網串連地址。	am-bp163885f8q21****.ads.aliyuncs.com
RdsInstanceId	string	同步源 RDS 執行個體 ID。僅 MySQL 分析執行個體會返回該參數。	rm-bp11q28kvl688****
DBClusterType	string	叢集類型，取值說明： Common：常規叢集。 RDS_ANALYSIS：MySQL 分析執行個體。	Common
CommodityCode	string	商品 code，固定為 ads。	ads
ExpireTime	string	叢集到期時間，UTC 時間，格式為yyyy-MM-ddTHH:mm:ssZ，例如2999-09-08T16:00:00Z。說明若目的地組群付費模式為訂用帳戶，則返回實際到期時間。若目的地組群付費模式為隨用隨付，則返回固定值2999-09-08T16:00:00Z。	2999-09-08T16:00:00Z
DBNodeStorage	integer	叢集的儲存空間，單位：GB。	300
DBNodeClass	string	節點規格。	E8
LockReason	string	叢集鎖定原因。說明僅當叢集被鎖定時會返回該參數，固定為instance_expire。	instance_expired
VPCId	string	Virtual Private CloudID。	vpc-bp13h7uzhulpuxvnpXXXX
RegionId	string	叢集所在的地區 ID。	cn-hangzhou
ComputeResource	string	彈性模式下使用的計算資源規格，用於資料計算。增加計算資源能加快查詢速度，可以根據叢集實際效能按需彈性擴縮。	8Core32GB
ElasticIOResource	integer	彈性 IO 資源（Elastic IO Unit，簡稱 EIU），更多詳情，請參見 EIU 詳解。說明僅彈性模式叢集會返回該參數。	0
VSwitchId	string	交換器 ID。	vsw-bp1syh8vvw8yech7nXXXX
DBVersion	string	資料庫版本，當前僅支援3.0版本。	3.0
VPCCloudInstanceId	string	VPC 執行個體 ID。	am-bp163885f8q21****-controller
DBClusterStatus	string	叢集狀態。更多詳情，請參見叢集狀態表。	Running
ResourceGroupId	string	資源群組 ID。	rg-acfmyiu4ekp****
DBClusterNetworkType	string	叢集網路類型。僅支援 VPC（專用網路）類型。	vpc
DBClusterDescription	string	叢集的描述資訊。	adb_test
ZoneId	string	叢集所在的可用性區域 ID。	cn-hangzhou-h
Category	string	產品系列，取值說明： BASIC：預留模式基礎版 CLUSTER：預留模式叢集版 MIXED_STORAGE：彈性模式叢集版（新版）說明更多關於叢集系列的介紹，請參見產品系列。	MIXED_STORAGE
Engine	string	叢集引擎，固定為 AnalyticDB。	AnalyticDB
InnerIp	string	公網 IP。	10.1.xx.xx
InnerPort	string	連接埠號碼。	3306
TaskInfo	object	任務進度資訊。
Name	string	任務名稱。	analyticDBFlexibleScaleOut
Status	string	任務狀態，取值為： NOT_RUN：等待運行。 RUNNING：運行中。 SUCCEED：已結束。	RUNNING
Progress	string	任務進度，單位：%。	10
StepList	object
StepList	array<object>	任務步驟。
	object	任務步驟。
StepName	string	步驟名稱。	ApplyResource
StepDesc	string	步驟描述。	Apply resource
StepStatus	string	步驟狀態，取值為： NOT_RUN：等待運行。 RUNNING：運行中。 SUCCEED：已結束。	SUCCEED
StepProgress	string	步驟進度，單位：%。	50
StartTime	string	步驟開始時間，格式為 YYYY-MM-DDThh:mm:ssZ。	2024-03-10T09:28:34Z
EndTime	string	步驟結束時間，格式為 YYYY-MM-DDThh:mm:ssZ。	2024-03-10T10:28:34Z
ProductVersion	string	產品版本。取值為： BasicVersion：基礎版。 EnterpriseVersion：企業版。	EnterpriseVersion

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "DtsJobId": "dtsb1578j90XXXX",
        "DBNodeCount": 1,
        "Expired": "false",
        "CreateTime": "2021-04-01T09:50:18Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "8Core32GB",
        "ExecutorCount": "1",
        "DBClusterId": "am-bp163885f8q21****",
        "ConnectionString": "am-bp163885f8q21****.ads.aliyuncs.com",
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "DBClusterType": "Common",
        "CommodityCode": "ads",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBNodeStorage": 300,
        "DBNodeClass": "E8",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnpXXXX",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "8Core32GB",
        "ElasticIOResource": 0,
        "VSwitchId": "vsw-bp1syh8vvw8yech7nXXXX",
        "DBVersion": "3.0",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "vpc",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Category": "MIXED_STORAGE",
        "Engine": "AnalyticDB",
        "InnerIp": "10.1.xx.xx",
        "InnerPort": "3306",
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Apply resource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductVersion": "EnterpriseVersion"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	An error occurred while processing your request.	系統內部錯誤，請稍後重試
503	ServiceUnavailable	An error occurred while processing your request.	系統暫時不可用，請稍後重試

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

變更歷史

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