调用DescribeDBClusters查询AnalyticDB MySQL实例列表。

调试

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

请求参数

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

系统规定参数。取值:DescribeDBClusters。

RegionId String cn-hangzhou

地域ID,您可通过接口DescribeRegions查看可用的地域ID。

DBClusterIds String am-bp1xxxxxxxx47

实例ID。如果有多个实例ID,以英文逗号(,)分隔。

DBClusterDescription String 测试数据库

实例描述,支持模糊查询。

DBClusterStatus String Running

实例状态,例如实例创建中、锁定中等,详情请参见实例状态表

PageSize Integer 30

每页记录数,取值:

  • 30
  • 50
  • 100

默认值:30。

PageNumber Integer 1

页码,取值:大于0且不超过Integer的最大值。默认值:1。

Tag.N.Key String test

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

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

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

说明 若传入Tag.n.Key,则Tag.n.Vlaue不能为空。

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

ResourceGroupId String rg-rexxxxxxxxxx

资源组ID。

返回数据

名称 类型 示例值 描述
Items Array of DBCluster

实例列表。

DBCluster
Category String Basic

实例系列。Basic:基础版。

CommodityCode String AnalyticDB for MySQL

售卖商品Code。

ComputeResource String 24Core192GB

弹性模式下使用的计算资源规格,用于数据计算。增加资源能加快查询速度,根据实际性能按需弹性扩缩。请参考规格详情

ConnectionString String am-bpxxxxxxxx.ads.aliyuncs.com

实例的地址。

CreateTime String 2019-03-20T02:18:02Z

创建时间。

DBClusterDescription String 测试数据库

实例描述。

DBClusterId String am-bpxxxxxxxx47

数据库实例ID。

DBClusterNetworkType String VPC

网络类型。取值:

  • Public:公网。
  • VPC:VPC。
DBClusterStatus String Running

实例状态,详情请参见实例状态表

DBClusterType String Common

实例类型。取值:Common,主实例。

DBNodeClass String C8

节点类型。

DBNodeCount Long 128

节点组个数。

DBNodeStorage Long 100

实例每个节点的存储空间。

DBVersion String 3.0

实例版本,目前只有3.0。

DiskType String cloud

磁盘类型:

  • cloud:普通云盘
  • cloud_ssd:SSD盘
  • cloud_efficiency:高效云盘
  • cloud_essd:PL1 等级的ESSD云盘,请参见ESSD云盘规格
  • cloud_essd2:PL2 等级的ESSD云盘,请参见ESSD云盘规格
  • cloud_essd3:PL3 等级的ESSD云盘,请参见ESSD云盘规格
DtsJobId String dtsb1xxxxxxxxxx

DTS同步任务ID,仅分析实例有值。

ElasticIOResource Integer 0

弹性IO资源。

Engine String AnalyticDB

引擎,AnalyticDB。

ExecutorCount String 3

弹性模式下用的计算资源规格,对应后台实际的节点数。

ExpireTime String 2020-03-20T02:18:02Z

到期时间。

说明 按量付费集群无到期时间。
Expired String false

实例过期状态:

  • true:已过期。
  • false:未过期。
LockMode String unlock

实例锁定模式:

  • Unlock:正常。
  • ManualLock:手动触发锁定。
  • LockByExpiration:实例过期自动锁定。
  • LockByRestoration:实例回滚前自动锁定。
  • LockByDiskQuota:实例空间满自动锁定。
LockReason String instance_expired

锁定原因。

Mode String flexible

模式:

  • flexible:弹性模式,ECS云服务器形态。
  • reserver:预留模式,物理机形态。
PayType String Postpaid

实例的付费类型:

  • Postpaid:按量付费;
  • Prepaid:预付费(包年包月)。
Port String 3306

实例的端口。

RdsInstanceId String rm-bp1oxxxxxxxxxx

同步源RDS实例ID,仅分析实例有值。

RegionId String cn-hangzhou

地域ID。

ResourceGroupId String rg-rexxxxxxxxxx

资源组ID。

StorageResource String 24Core192GB

弹性模式用的数据资源规格,用于数据读写。增加资源能提高集群读写能力。请参见规格详情

Tags Array of Tag

标签信息列表。

Tag
Key String test

标签键。

Value String api

标签值。

VPCCloudInstanceId String vpc-23rsxdfxxxxxxx

VPC资源ID。

VPCId String vpc-xxxxxxxxx

VPC ID。

VSwitchId String vsw-xxxxxx

交换机ID。

ZoneId String cn-hangzhou-a

可用区ID。

PageNumber Integer 1

页码。

PageSize Integer 2

总页数。

TotalCount Integer 100

总记录数。

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<TotalCount>100</TotalCount>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PageSize>2</PageSize>
<PageNumber>1</PageNumber>
<Items>
    <DBCluster>
        <StorageResource>24Core192GB</StorageResource>
        <Category>Basic</Category>
        <ResourceGroupId>rg-rexxxxxxxxxx</ResourceGroupId>
        <Port>3306</Port>
        <DBClusterId>am-bpxxxxxxxx47</DBClusterId>
        <DBClusterNetworkType>VPC</DBClusterNetworkType>
        <DBClusterType>Common</DBClusterType>
        <DiskType>cloud</DiskType>
        <DBVersion>3.0</DBVersion>
        <DtsJobId>dtsb1xxxxxxxxxx</DtsJobId>
        <DBNodeCount>128</DBNodeCount>
        <CommodityCode>AnalyticDB for MySQL</CommodityCode>
        <ExecutorCount>3</ExecutorCount>
        <LockReason>instance_expired</LockReason>
        <Engine>AnalyticDB</Engine>
        <DBNodeStorage>100</DBNodeStorage>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <VPCId>vpc-xxxxxxxxx</VPCId>
        <DBClusterStatus>Running</DBClusterStatus>
        <CreateTime>2019-03-20T02:18:02Z</CreateTime>
        <VSwitchId>vsw-xxxxxx</VSwitchId>
        <Mode>flexible</Mode>
        <DBClusterDescription>测试数据库</DBClusterDescription>
        <ComputeResource>24Core192GB</ComputeResource>
        <Expired>false</Expired>
        <PayType>Postpaid</PayType>
        <LockMode>unlock</LockMode>
        <DBNodeClass>C8</DBNodeClass>
        <VPCCloudInstanceId>vpc-23rsxdfxxxxxxx</VPCCloudInstanceId>
        <RegionId>cn-hangzhou</RegionId>
        <ExpireTime>2020-03-20T02:18:02Z</ExpireTime>
        <ConnectionString>am-bpxxxxxxxx.ads.aliyuncs.com</ConnectionString>
        <RdsInstanceId>rm-bp1oxxxxxxxxxx</RdsInstanceId>
    </DBCluster>
    <DBCluster>
        <Tags>
            <Tag>
                <Value>api</Value>
                <Key>test</Key>
            </Tag>
        </Tags>
    </DBCluster>
</Items>

JSON 格式

{
    "TotalCount": 100,
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "PageSize": 2,
    "PageNumber": 1,
    "Items": {
        "DBCluster": [
            {
                "StorageResource": "24Core192GB",
                "Category": "Basic",
                "ResourceGroupId": "rg-rexxxxxxxxxx",
                "Port": 3306,
                "DBClusterId": "am-bpxxxxxxxx47",
                "DBClusterNetworkType": "VPC",
                "DBClusterType": "Common",
                "DiskType": "cloud",
                "DBVersion": 3,
                "DtsJobId": "dtsb1xxxxxxxxxx",
                "DBNodeCount": 128,
                "CommodityCode": "AnalyticDB for MySQL",
                "ExecutorCount": 3,
                "LockReason": "instance_expired",
                "Engine": "AnalyticDB",
                "DBNodeStorage": 100,
                "ZoneId": "cn-hangzhou-a",
                "VPCId": "vpc-xxxxxxxxx",
                "DBClusterStatus": "Running",
                "CreateTime": "2019-03-20T02:18:02Z",
                "VSwitchId": "vsw-xxxxxx",
                "Mode": "flexible",
                "DBClusterDescription": "测试数据库",
                "ComputeResource": "24Core192GB",
                "Expired": false,
                "PayType": "Postpaid",
                "LockMode": "unlock",
                "DBNodeClass": "C8",
                "VPCCloudInstanceId": "vpc-23rsxdfxxxxxxx",
                "RegionId": "cn-hangzhou",
                "ExpireTime": "2020-03-20T02:18:02Z",
                "ConnectionString": "am-bpxxxxxxxx.ads.aliyuncs.com",
                "RdsInstanceId": "rm-bp1oxxxxxxxxxx"
            },
            {
                "Tags": {
                    "Tag": {
                        "Value": "api",
                        "Key": "test"
                    }
                }
            }
        ]
    }
}

错误码

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

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