调用DescribeDBClusters查询实例列表_云原生数据仓库AnalyticDB(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 且不超过 Integer 数据类型的最大值。默认值为 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

返回参数

名称	类型	描述	示例值
	object	列表详情。
TotalCount	integer	总记录数。	1
PageSize	integer	每页记录数。	30
RequestId	string	请求 ID。	D65A809F-34CE-4550-9BC1-0ED21ETG380
PageNumber	integer	页码。	1
Items	array<object>	集群信息列表。
DBCluster	object	列表详情。
DtsJobId	string	DTS 同步任务 ID。仅 MySQL 分析实例会返回该参数。更多详情，请参见 MySQL 分析实例简介。	dtsb1578j90XXXX
DBNodeCount	long	节点组个数。	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	array<object>	标签信息列表。
Tag	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 分析实例会返回该参数。更多详情，请参见 MySQL 分析实例简介。	rm-bp11q28kvl688****
DBClusterType	string	集群类型，取值说明： Common：常规集群。 RDS_ANALYSIS：MySQL 分析实例。更多详情，请参见 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	long	集群的存储空间，单位：GB。	300
DBNodeClass	string	节点规格。	E8
LockReason	string	集群锁定原因。说明仅当集群被锁定时会返回该参数，固定为instance_expire。	instance_expired
VPCId	string	专有网络（VPC）ID。	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	array<object>	任务步骤。
StepList	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.	系统暂时不可用，请稍后重试

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

变更历史

变更时间	变更内容概要	操作
2024-05-28	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-04-01	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情