使用DescribeDBClusterAttribute查詢叢集詳細資料-雲原生資料倉儲AnalyticDB-阿里雲

查看指定叢集的詳細資料。

介面說明

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

adb:DescribeDBClusterAttribute

get

*DBClusterLakeVersion

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	湖倉版叢集 ID。說明調用 DescribeDBClusters 介面可以查詢叢集 ID。	amv-wz9509beptiz****

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	A5C433C2-001F-58E3-99F5-3274C14DF8BD
Items	object
DBCluster	array<object>	湖倉版叢集資訊列表。
	array<object>	叢集詳情。
CreationTime	string	叢集建立時間。UTC 時間，格式為`yyyy-MM-ddThh:mm:ssZ`。	2022-07-01T09:50:18Z
Expired	string	訂用帳戶叢集是否到期。取值說明： true：已到期。 false：未到期。說明如果叢集已到期，在一定時間內叢集會被鎖定甚至釋放。建議您進行續約操作，詳情請參見續約說明。隨用隨付叢集不返回此參數。	false
MaintainTime	string	叢集的可維護時間。UTC 時間，格式為`HH:mmZ-HH:mmZ`。說明更多關於可維護時間段的資訊，請參見設定可維護時間段。	04:00Z-05:00Z
PayType	string	叢集付費類型，取值說明： Postpaid：隨用隨付。 Prepaid：訂用帳戶。	Prepaid
Tags	object
Tag	array<object>	標籤列表。
	object
Key	string	標籤鍵。說明您可以調用 TagResources 介面為目的地組群建立標籤。	tag1
Value	string	標籤值。	test1
Mode	string	叢集模式。預設返回 flexible，表示彈性模式叢集。	flexible
Port	integer	叢集連接埠號碼。	3306
LockMode	string	叢集的鎖定模式，取值說明： Unlock：未鎖定。 ManualLock：手動觸發鎖定。 LockByExpiration：叢集到期自動鎖定。	ManualLock
EngineVersion	string	叢集引擎版本。	3.1.16
StorageResource	string	儲存預留資源規格。1 ACU 約等於 1 核 4 GB。儲存資源用於資料讀寫，增加該資源能提高叢集讀寫能力。	24ACU
DBClusterId	string	<props="intl">湖倉版叢集 ID。</prop	amv-wz9509beptiz****
ConnectionString	string	叢集的 VPC 地址。	amv-wz9509beptiz****.ads.aliyuncs.com
DBClusterType	string	叢集類型。預設返回 Common，表示常規叢集。	Common
CommodityCode	string	商品付費類型，取值說明： ads：隨用隨付商品。 ads_pre：訂用帳戶商品。	ads_pre
ExpireTime	string	叢集到期時間。若叢集付費類型為訂用帳戶，則返回實際到期時間。若叢集付費類型為隨用隨付，則返回為空白。	2022-10-01T09:50:18Z
LockReason	string	叢集鎖定原因。說明僅當叢集被鎖定時會返回該參數，固定為instance_expire。	instance_expire
VPCId	string	Virtual Private CloudID。	vpc-bp13h7uzhulpu****
ComputeResource	string	計算預留資源規格。1 ACU 約等於 1 核 4 GB。計算資源用於資料計算，增加計算資源能加快查詢速度，可以根據叢集實際效能按需彈性擴縮。	16ACU
RegionId	string	叢集所在的地區 ID。	cn-hangzhou
VSwitchId	string	交換器 ID。	vsw-uf629gydd54ld****
DBVersion	string	AnalyticDB MySQL 叢集的版本，當前僅支援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
UserENIStatus	boolean	是否已啟用 ENI（Elastic Network Interface，彈性網卡）網路，取值說明： true：已啟用。 false：未啟用。	false
ZoneId	string	叢集所在的可用性區域 ID。	cn-hangzhou-h
Engine	string	叢集引擎，固定為 AnalyticDB。	AnalyticDB
ReservedACU	string	叢集剩餘可分配計算預留資源。1 ACU 約等於 1 核 4 GB。	24ACU
ComputeResourceTotal	string	叢集計算總資源量。1 ACU 約等於 1 核 4 GB。	48ACU
StorageResourceTotal	string	叢集儲存總資源量。1 ACU 約等於 1 核 4 GB。	24ACU
SupportedFeatures	object	預留參數，不涉及。
	string	預留參數，不涉及。	預留參數，不涉及。
ProductForm	string	預留參數，不涉及。	預留參數，不涉及。
ReservedNodeSize	string	預留參數，不涉及。	預留參數，不涉及。
ReservedNodeCount	integer	預留參數，不涉及。	預留參數，不涉及。
ClickhouseEngineEnabled	boolean	ClickHouse 寬表引擎是否開啟。 true: 已開啟 Clickhouse 寬表引擎。 false: 未開啟 Clickhouse 寬表引擎。枚舉值： true : true false : false	true
AINodeNumber	integer
ProductVersion	string	產品版本。取值為： BasicVersion：基礎版。 EnterpriseVersion：企業版。	BasicVersion
KmsId	string	用於加密雲端硬碟資料的金鑰識別碼。說明僅當 AnalyticDB MySQL 叢集開啟雲端硬碟加密時才會返回該參數。	e1935511-cf88-1123-a0f8-1be8d251****
TaskInfo	object	任務資訊。
Name	string	任務名稱。	ScaleUpDBCluster
Status	string	任務狀態，取值為： NOT_RUN：等待運行。 RUNNING：運行中。 SUCCEED：已結束。	RUNNING
Progress	string	任務進度，單位：%。	10
StepList	object
StepList	array<object>	任務步驟。
	object	任務步驟。
StepName	string	步驟名稱。	PrepareResources
StepDesc	string	步驟描述。	Prepare resources
StepStatus	string	步驟狀態，取值為： NOT_RUN：等待運行。 RUNNING：運行中。 SUCCEED：已結束。	RUNNING
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
UserENIVpcId	string	ENI 的 VPC 資訊。	vpc-rj9hnedlfm645uj******
UserENIVSwitchOptions	string	ENI 交換器列表。多個交換器中間用英文逗號（,）分隔。	vsw-rj9ixufmywqq98z****,vsw-rj95ij6wcz656v7****
UserENIZoneOptions	string	ENI 可用性區域資訊。多個可用性區域之間用英文逗號（,）分隔。	cn-hangzhou-k,cn-hangzhou-h
SecondaryZoneId	string
SecondaryVSwitchId	string
DiskEncryption	boolean
ClickhouseEngineCacheSize	integer	ClickHouse 寬表引擎的緩衝大小，單位：GB。若返回-1，則表示未開啟寬表引擎。若返回具體數字，則表示雲端硬碟緩衝空間大小。	100
AINodeSpec	string

樣本

正常返回樣本

JSON格式

{
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD",
  "Items": {
    "DBCluster": [
      {
        "CreationTime": "2022-07-01T09:50:18Z",
        "Expired": "false",
        "MaintainTime": "04:00Z-05:00Z",
        "PayType": "Prepaid",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": 3306,
        "LockMode": "ManualLock",
        "EngineVersion": "3.1.16",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-wz9509beptiz****",
        "ConnectionString": "amv-wz9509beptiz****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-10-01T09:50:18Z",
        "LockReason": "instance_expire",
        "VPCId": "vpc-bp13h7uzhulpu****",
        "ComputeResource": "16ACU",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-uf629gydd54ld****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "UserENIStatus": false,
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "24ACU",
        "ComputeResourceTotal": "48ACU",
        "StorageResourceTotal": "24ACU",
        "SupportedFeatures": {
          "key": "預留參數，不涉及。"
        },
        "ProductForm": "預留參數，不涉及。",
        "ReservedNodeSize": "預留參數，不涉及。",
        "ReservedNodeCount": 0,
        "ClickhouseEngineEnabled": true,
        "AINodeNumber": 0,
        "ProductVersion": "BasicVersion",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "TaskInfo": {
          "Name": "ScaleUpDBCluster",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "PrepareResources",
                "StepDesc": "Prepare resources",
                "StepStatus": "RUNNING",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "UserENIVpcId": "vpc-rj9hnedlfm645uj******",
        "UserENIVSwitchOptions": "vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******",
        "UserENIZoneOptions": "cn-hangzhou-k,cn-hangzhou-h",
        "SecondaryZoneId": "",
        "SecondaryVSwitchId": "",
        "DiskEncryption": true,
        "ClickhouseEngineCacheSize": 100,
        "AINodeSpec": ""
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。

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

變更歷史

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