调用DescribeDBClusters接口查看目标地域下的AnalyticDB MySQL版集群列表信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBClusters

系统规定参数。取值:DescribeDBClusters

RegionId String cn-hangzhou

地域ID。

说明 您可以调用DescribeRegions接口查看可用地域的地域ID。
DBClusterIds String am-************

集群ID。

DBClusterDescription String test

集群描述。

DBClusterStatus String Running

集群状态。

PageSize Integer 30

每页记录数,取值为30(默认值)、50100

PageNumber Integer 1

页码,取值为大于0且不超过Integer数据类型的最大值。默认值为1

ResourceGroupId String rg-***************

资源组ID。

Tag.N.Key String tag1

标签键,可以根据标签过滤集群列表。最多20对标签,各个标签对的数字n必须不同,且必须是从1开始的连续整数。Tag.n.Key对应的值为Tag.n.Value。

说明 最多支持64个字符,不能以aliyun、acs:、http://或者https://开头。
Tag.N.Value String test1

标签值,可以根据标签过滤集群列表。最多20对标签,各个标签对的数字n必须不同,且必须是从1开始的连续整数。Tag.n.Value是Tag.n.Key的值。

说明 最多支持64个字符,不能以aliyunacs:http://或者https://开头。

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

总记录数。

PageSize Integer 30

本页记录数。

RequestId String D65A809F-34CE-4550-9BC1-0ED21E******

请求ID。

PageNumber Integer 1

页数。

Items Array of DBCluster

集群信息列表。

DBCluster
DtsJobId String dtsb1***********

DTS同步任务ID。仅MySQL分析实例会返回该参数。更多详情,请参见MySQL分析实例简介

DBNodeCount Long 1

节点组个数。

Expired String false

集群是否过期。取值范围如下:

  • true:已过期。
  • false:未过期。
CreateTime String 2021-04-01T09:50:18Z

集群创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间),例如2021-04-01T09:50:18Z

PayType String Postpaid

集群付费类型,取值范围如下:

  • Postpaid:按量付费(即后付费)。
  • Prepaid:包年包月(即预付费)。
DiskType String cloud_essd

集群的磁盘类型,取值范围如下:

  • local_ssd:本地磁盘。
  • cloud:普通云盘。
  • cloud_ssd:SSD云盘。
  • cloud_efficiency:高效云盘。
  • cloud_essd:PL1等级的ESSD云盘。
  • cloud_essd2:PL2 等级的ESSD云盘。
  • cloud_essd3:PL3 等级的ESSD云盘。
说明 更多关于ESSD云盘的详情,请参见ESSD云盘规格
Tags Array of Tag

标签信息列表。

Tag
Key String tag1

标签键。

说明 您可以调用TagResources接口为目标集群创建标签。
Value String test1

标签值。

Mode String flexible

集群模式,取值范围如下:

  • flexible:弹性模式。
  • reserver:预留模式。
说明 更多关于集群模式的介绍,请参见产品系列
Port String 3306

集群端口号,默认为3306。

LockMode String Unlock

集群的锁定模式,取值范围如下:

  • Unlock:正常(即未锁定)。
  • ManualLock:手动触发锁定。
  • LockByExpiration:集群过期自动锁定。
  • LockByRestoration:集群回滚前自动锁定。
  • LockByDiskQuota:集群中空间满(即数据占用的存储空间已到达上限水位的90%)自动锁定。
StorageResource String 8Core32GB

弹性模式用的存储资源规格,用于数据读写,增加该资源能提高集群读写能力。

ExecutorCount String 1

弹性模式下集群使用的计算节点数量。

DBClusterId String am-*****************

集群ID。

ConnectionString String am-************************.ads.aliyuncs.com

集群的公网连接地址。

RdsInstanceId String rm-***************

同步源RDS实例ID。仅MySQL分析实例会返回该参数。更多详情,请参见MySQL分析实例简介

DBClusterType String Common

集群或实例类型:

CommodityCode String ads

商品code,固定为ads

ExpireTime String 2999-09-08T16:00:00Z

集群到期时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间),例如2999-09-08T16:00:00Z

说明
  • 若目标集群付费模式为包年包月,则返回实际到期时间。
  • 若目标集群付费模式为按量付费,则返回固定值2999-09-08T16:00:00Z
DBNodeStorage Long 300

集群的存储空间,单位:GB。

DBNodeClass String E8

节点规格。

LockReason String instance_expired

集群锁定原因。

说明 仅当集群被锁定时会返回该参数,固定为instance_expire
VPCId String vpc-********************

专有网络(VPC)ID。

RegionId String cn-hangzhou

集群所在的地域ID。

ComputeResource String 8Core32GB

弹性模式下使用的计算资源规格,用于数据计算。增加计算资源能加快查询速度,可以根据集群实际性能按需弹性扩缩。

ElasticIOResource Integer 0

弹性IO资源(Elastic IO Unit,简称EIU),更多详情,请参见EIU详解

说明 仅弹性模式集群会返回该参数。
VSwitchId String vsw-********************

交换机ID。

DBVersion String 3.0

数据库版本,当前仅支持3.0版本。

VPCCloudInstanceId String am-****************-controller"

VPC实例ID。

DBClusterStatus String Running

集群状态。更多详情,请参见集群状态表

ResourceGroupId String rg-***************

资源组ID。

DBClusterNetworkType String vpc

集群网络类型。仅支持VPC(专有网络)类型。

DBClusterDescription String adb_test

集群的描述信息。

ZoneId String cn-hangzhou-h

集群所在的可用区ID。

Category String MIXED_STORAGE

产品系列,取值范围如下:

  • BASIC:基础版
  • CLUSTER:集群版
  • MIXED_STORAGE:集群版(新版)
说明 更多关于集群系列的介绍,请参见产品系列
Engine String AnalyticDB

集群引擎,固定为AnalyticDB

示例

请求示例

http(s)://adb.aliyuncs.com/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&DBClusterIds=am-************
&DBClusterDescription=adb_test
&DBClusterStatus=Running
&PageSize=30
&PageNumber=1
&ResourceGroupId=rg-***************
&Tag=[{"Key":"tag1","Value":"test1"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClustersResponse>
    <TotalCount>1</TotalCount>
    <RequestId>D65A809F-34CE-4550-9BC1-0ED21E******</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <Items>
        <DBCluster>
            <StorageResource>8Core32GB</StorageResource>
            <Category>MIXED_STORAGE</Category>
            <ResourceGroupId>rg-***************</ResourceGroupId>
            <Port>3306</Port>
            <DBClusterId>am-****************</DBClusterId>
            <DBClusterNetworkType>VPC</DBClusterNetworkType>
            <DBClusterType>Common</DBClusterType>
            <DiskType>cloud_essd</DiskType>
            <ElasticIOResource>0</ElasticIOResource>
            <DBVersion>3.0</DBVersion>
            <DtsJobId/>
            <DBNodeCount>1</DBNodeCount>
            <CommodityCode>ads</CommodityCode>
            <ExecutorCount>1</ExecutorCount>
            <LockReason/>
            <Engine>AnalyticDB</Engine>
            <Tags>
                <Tag>
                    <Value>test1</Value>
                    <Key>tag1</Key>
                </Tag>
            </Tags>
            <DBNodeStorage>300</DBNodeStorage>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <VPCId>vpc-*******************</VPCId>
            <DBClusterStatus>Running</DBClusterStatus>
            <CreateTime>2021-04-01T09:50:18Z</CreateTime>
            <VSwitchId>vsw-*******************</VSwitchId>
            <Mode>flexible</Mode>
            <DBClusterDescription>adb_test</DBClusterDescription>
            <ComputeResource>8Core32GB</ComputeResource>
            <PayType>Postpaid</PayType>
            <LockMode>Unlock</LockMode>
            <DBNodeClass>E8</DBNodeClass>
            <VPCCloudInstanceId>am-****************-controller</VPCCloudInstanceId>
            <RegionId>cn-hangzhou</RegionId>
            <ExpireTime>2999-09-08T16:00:00Z</ExpireTime>
            <ConnectionString>am-***********************.ads.aliyuncs.com</ConnectionString>
            <RdsInstanceId/>
        </DBCluster>
    </Items>
</DescribeDBClustersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "D65A809F-34CE-4550-9BC1-0ED21E******",
  "PageSize" : 30,
  "PageNumber" : 1,
  "Items" : {
    "DBCluster" : [ {
      "StorageResource" : "8Core32GB",
      "Category" : "MIXED_STORAGE",
      "ResourceGroupId" : "rg-***************",
      "Port" : "3306",
      "DBClusterId" : "am-****************",
      "DBClusterNetworkType" : "VPC",
      "DBClusterType" : "Common",
      "DiskType" : "cloud_essd",
      "ElasticIOResource" : 0,
      "DBVersion" : "3.0",
      "DtsJobId" : "",
      "DBNodeCount" : 1,
      "CommodityCode" : "ads",
      "ExecutorCount" : 1,
      "LockReason" : "",
      "Engine" : "AnalyticDB",
      "Tags" : {
        "Tag" : [ {
          "Value" : "test1",
          "Key" : "tag1"
        } ]
      },
      "DBNodeStorage" : 300,
      "ZoneId" : "cn-hangzhou-h",
      "VPCId" : "vpc-*******************",
      "DBClusterStatus" : "Running",
      "CreateTime" : "2021-04-01T09:50:18Z",
      "VSwitchId" : "vsw-*******************",
      "Mode" : "flexible",
      "DBClusterDescription" : "adb_test",
      "ComputeResource" : "8Core32GB",
      "PayType" : "Postpaid",
      "LockMode" : "Unlock",
      "DBNodeClass" : "E8",
      "VPCCloudInstanceId" : "am-****************-controller",
      "RegionId" : "cn-hangzhou",
      "ExpireTime" : "2999-09-08T16:00:00Z",
      "ConnectionString" : "am-***********************.ads.aliyuncs.com",
      "RdsInstanceId" : ""
    } ]
  }
}

错误码

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

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