调用DescribeDBClusters查询湖仓版集群列表-云原生数据仓库AnalyticDB-阿里云-云原生数据仓库AnalyticDB(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 且不超过 Integer 数据类型的正整数。默认值为 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	专有网络（VPC）ID。	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 分析实例会返回该参数。更多详情，请参见 MySQL 分析实例简介。	dtsb1578j90XXXX
ElasticIOResource	integer	弹性 IO 资源（Elastic IO Unit，简称 EIU），更多详情，请参见 EIU 详解。说明仅弹性模式集群会返回该参数。	2
RdsInstanceId	string	同步源 RDS 实例 ID。仅 MySQL 分析实例会返回该参数。更多详情，请参见 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	AI 节点规格。	ADB.MLGrand.5
AINodeNumber	integer	AI 节点数量。	1

示例

正常返回示例

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": "ADB.MLGrand.5",
        "AINodeNumber": 1
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	An error occurred while processing your request.	系统内部错误，请稍后重试
503	ServiceUnavailable	An error occurred while processing your request.	系统暂时不可用，请稍后重试

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。