使用DescribeDBClusters查詢叢集列表-雲原生資料倉儲AnalyticDB-阿里雲

查看目標地區下的湖倉版叢集列表資訊。

介面說明

當前服務的接入地址請參見服務存取點。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

adb:DescribeDBClusters

list

*DBClusterLakeVersion

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	地區 ID。說明您可以調用 DescribeRegions 介面查看地區 ID。	cn-hangzhou
DBClusterIds	string	否	湖倉版叢集 ID。此參數不填寫時，預設返回該地區中所有叢集的資訊。	amv-bp1r053byu48p****
DBClusterDescription	string	否	叢集描述。不能以`http://`或者`https://`開頭。長度為 2~256 個字元。	test
DBClusterStatus	string	否	叢集狀態，取值說明： Preparing：準備中。 Creating：建立中。 Running：運行中。 Deleting：刪除中。 Restoring：備份恢複中。 ClassChanging：變更配置中。 NetAddressCreating：建立網路中。 NetAddressDeleting：刪除網路中。 NetAddressModifying：修改網路中。	Running
PageSize	integer	否	每頁記錄數，取值： 30（預設值） 50 100	30
PageNumber	integer	否	頁碼，取值為大於 0 且不超過整數資料類型的正整數。預設值為 1。	1
ResourceGroupId	string	否	資源群組 ID。此參數不填寫時，預設返回叢集中所有資源群組資訊。	rg-4690g37929****
Tag	array<object>	否	叢集的標籤資訊。
	object	否	叢集標籤資訊。
Key	string	否	叢集的標籤鍵。	tag1
Value	string	否	叢集的標籤值。	test1
ProductVersion	string	否	產品版本： EnterpriseVersion：企業版。 BasicVersion：基礎版。說明選填參數，不填時預設返回全部叢集。	BasicVersion
DBClusterVersion	string	否	叢集版本 3.0：數倉版。 5.0（預設值）：包括湖倉版、企業版和基礎版。 All：所有版本，包括數倉版、湖倉版、企業版和基礎版。	5.0

返回參數

名稱	類型	描述	樣本值
	object
TotalCount	integer	總記錄數。	1
PageSize	integer	每頁記錄數。	30
RequestId	string	請求 ID。	A5EDBA27-AF3E-5966-9503-FD1557E19167
PageNumber	integer	頁碼。	1
Items	object
DBCluster	array<object>	列表詳情。
	array<object>	叢集列表。
Expired	string	訂用帳戶叢集是否到期。取值說明： true：已到期。 false：未到期。說明如果叢集已到期，在一定時間內叢集會被鎖定甚至釋放。建議您進行續約操作，詳情請參見續約說明。隨用隨付叢集不返回此參數。	false
CreateTime	string	叢集建立時間。UTC 時間，格式為yyyy-mm-ddThh:mm:ssZ。	2022-04-01T09:50:18Z
PayType	string	叢集付費類型，取值說明： Postpaid：隨用隨付。 Prepaid：訂用帳戶。	Prepaid
Mode	string	叢集模式。預設返回 flexible，表示彈性模式叢集。	flexible
Port	string	叢集連接埠號碼。	3306
LockMode	string	叢集的鎖定狀態，取值說明： Unlock：未鎖定。 ManualLock：手動觸發鎖定。 LockByExpiration：叢集到期自動鎖定。	Unlock
StorageResource	string	儲存預留資源規格。1 ACU 約等於 1 核 4 GB。儲存資源用於資料讀寫，增加該資源能提高叢集讀寫能力。	24ACU
DBClusterId	string	湖倉版叢集 ID。	amv-bp163885f8q21****
ConnectionString	string	叢集的公網串連地址。	amv-bp163885f8q21****.ads.aliyuncs.com
DBClusterType	string	叢集類型。預設返回 Common，表示常規叢集。	Common
CommodityCode	string	商品付費類型，取值說明： ads：隨用隨付商品。 ads_pre：訂用帳戶商品。	ads_pre
ExpireTime	string	叢集到期時間，UTC 時間，格式為yyyy-MM-ddTHH:mm:ssZ。說明若叢集付費類型為訂用帳戶，則返回實際到期時間。若叢集付費類型為隨用隨付，則返回為空白。	2022-07-01T09:50:18Z
LockReason	string	叢集鎖定原因。說明僅當叢集被鎖定時會返回該參數，固定為instance_expire。	instance_expired
VPCId	string	Virtual Private CloudID。	vpc-bp13h7uzhulpuxvnp****
RegionId	string	叢集所在的地區 ID。	cn-hangzhou
ComputeResource	string	計算預留資源規格。1 ACU 約等於 1 核 4 GB。計算資源用於資料計算，增加計算資源能加快查詢速度，可以根據叢集實際效能按需彈性擴縮。	16ACU
VSwitchId	string	交換器 ID。	vsw-bp1syh8vvw8yech7n****
DBVersion	string	資料庫版本，當前僅支援5.0版本。	5.0
DBClusterStatus	string	叢集狀態，取值說明： Preparing：準備中。 Creating：建立中。 Running：運行中。 Deleting：刪除中。 Restoring：備份恢複中。 ClassChanging：變更配置中。 NetAddressCreating：建立網路中。 NetAddressDeleting：刪除網路中。 NetAddressModifying：修改網路中。	Running
ResourceGroupId	string	資源群組 ID。	rg-acfmyiu4ekp****
DBClusterNetworkType	string	叢集網路類型。僅支援 VPC（專用網路）類型。	VPC
DBClusterDescription	string	叢集的描述資訊。	adb_test
ZoneId	string	叢集所在的可用性區域 ID。	cn-hangzhou-h
Engine	string	叢集引擎，固定為 AnalyticDB。	AnalyticDB
ReservedACU	string	叢集剩餘可分配計算預留資源。1 ACU 約等於 1 核 4 GB。	32ACU
Tags	object
Tag	array<object>	標籤列表。
	object	標籤列表。
Key	string	標籤鍵。說明您可以調用 TagResources 介面為目的地組群建立標籤。	tag1
Value	string	標籤值。	test1
Category	string	產品系列，僅在執行個體為數倉版時該值有意義，取值說明： BASIC：預留模式基礎版。 CLUSTER：預留模式叢集版。 MIXED_STORAGE：彈性模式叢集版（新版）。說明更多關於叢集系列的介紹，請參見產品系列。	MIXED_STORAGE
InnerPort	string	叢集的內網串連連接埠。	3306
VPCCloudInstanceId	string	內網串連地址。	am-bp163885f8q21****-controller
InnerIp	string	叢集內網 IP 位址。	10.1.xx.xx
DtsJobId	string	DTS 同步任務 ID。僅 MySQL 分析執行個體會返回該參數。	dtsb1578j90XXXX
ElasticIOResource	integer	彈性 IO 資源（Elastic IO Unit，簡稱 EIU），更多詳情，請參見 EIU 詳解。說明僅彈性模式叢集會返回該參數。	2
RdsInstanceId	string	同步源 RDS 執行個體 ID。僅 MySQL 分析執行個體會返回該參數。	rm-bp11q28kvl688****
ExecutorCount	string	彈性模式下叢集使用的計算節點數量。	1
DBNodeClass	string	節點規格，僅在執行個體為數倉版時該值有意義。	E8
DiskType	string	叢集的磁碟類型，取值說明： local_ssd：本地磁碟。 cloud：普通雲端硬碟。 cloud_ssd：SSD 雲端硬碟。 cloud_efficiency：高效雲端硬碟。 cloud_essd：PL1 等級的 ESSD 雲端硬碟。 cloud_essd2：PL2 等級的 ESSD 雲端硬碟。 cloud_essd3：PL3 等級的 ESSD 雲端硬碟。說明更多關於 ESSD 雲端硬碟的詳情，請參見 ESSD 雲端硬碟規格。	cloud_essd
DBNodeStorage	integer	叢集的儲存空間，單位：GB。	300
DBNodeCount	integer	節點群組個數。	2
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
ProductForm	string	產品形態枚舉： LegacyForm: 傳統形態。 IntegrationForm：融合形態。	IntegrationForm
ProductVersion	string	產品版本。取值為： BasicVersion：基礎版。 EnterpriseVersion：企業版。	EnterpriseVersion
ReservedNodeSize	string	預留資源單節點規格。	8ACU
ReservedNodeCount	integer	預留資源節點數。	1
AINodeSpec	string
AINodeNumber	integer

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "A5EDBA27-AF3E-5966-9503-FD1557E19167",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "Expired": "false",
        "CreateTime": "2022-04-01T09:50:18Z",
        "PayType": "Prepaid",
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-bp163885f8q21****",
        "ConnectionString": "amv-bp163885f8q21****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-07-01T09:50:18Z",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnp****",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "16ACU",
        "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "32ACU",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Category": "MIXED_STORAGE",
        "InnerPort": "3306",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "InnerIp": "10.1.xx.xx",
        "DtsJobId": "dtsb1578j90XXXX",
        "ElasticIOResource": 2,
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "ExecutorCount": "1",
        "DBNodeClass": "E8",
        "DiskType": "cloud_essd",
        "DBNodeStorage": 300,
        "DBNodeCount": 2,
        "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"
              }
            ]
          }
        },
        "ProductForm": "IntegrationForm",
        "ProductVersion": "EnterpriseVersion",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 1,
        "AINodeSpec": "",
        "AINodeNumber": 0
      }
    ]
  }
}

錯誤碼

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

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

變更歷史

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