调用DescribeDBClusters接口查看目标地域下的AnalyticDB MySQL版集群列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBClusters |
系统规定参数。取值:DescribeDBClusters。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 说明 您可以调用DescribeRegions接口查看可用地域的地域ID。
|
DBClusterIds | String | 否 | am-bp1r053byu48p**** |
集群ID。 说明 您可以输入上述地域中任意的集群ID。
|
DBClusterDescription | String | 否 | test |
集群描述。
|
DBClusterStatus | String | 否 | Running |
集群状态,取值说明:
|
PageSize | Integer | 否 | 30 |
每页记录数,取值:
|
PageNumber | Integer | 否 | 1 |
页码,取值为大于0且不超过Integer数据类型的最大值。默认值为1。 |
ResourceGroupId | String | 否 | rg-4690g37929XXXX |
资源组ID。 |
Tag.N.Key | String | 否 | tag1 |
标签键,可以根据标签过滤集群列表。最多20对标签,各个标签对的数字n必须不同,且必须是从1开始的连续整数。 说明 最多支持64个字符,不能以
aliyun 、acs: 、http:// 或者https:// 开头。
|
Tag.N.Value | String | 否 | test1 |
标签值,可以根据标签过滤集群列表。最多20对标签,各个标签对的数字n必须不同,且必须是从1开始的连续整数。 说明 最多支持64个字符,不能以
aliyun 、acs: 、http:// 或者https:// 开头。
|
DBVersion | String | 否 | 3.0 |
集群版本,固定取值为3.0。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Integer | 1 |
总记录数。 |
PageSize | Integer | 30 |
每页记录数。 |
RequestId | String | D65A809F-34CE-4550-9BC1-0ED21ETG380 |
请求ID。 |
PageNumber | Integer | 1 |
页码。 |
Items | Array of DBCluster |
集群信息列表。 |
|
DBCluster | |||
DtsJobId | String | dtsb1578j90XXXX |
DTS同步任务ID。仅MySQL分析实例会返回该参数。更多详情,请参见MySQL分析实例简介。 |
DBNodeCount | Long | 1 |
节点组个数。 |
Expired | String | false |
集群是否过期。取值说明:
|
CreateTime | String | 2021-04-01T09:50:18Z |
集群创建时间,UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ,例如2021-04-01T09:50:18Z。 |
PayType | String | Postpaid |
集群付费类型,取值说明:
|
DiskType | String | cloud_essd |
集群的磁盘类型,取值说明:
说明 更多关于ESSD云盘的详情,请参见ESSD云盘规格。
|
Tags | Array of Tag |
标签信息列表。 |
|
Tag | |||
Key | String | tag1 |
标签键。 说明 您可以调用TagResources接口为目标集群创建标签。
|
Value | String | test1 |
标签值。 |
Mode | String | flexible |
集群模式,取值说明:
说明
|
Port | String | 3306 |
集群端口号,默认为3306。 |
LockMode | String | Unlock |
集群的锁定模式,取值说明:
|
StorageResource | String | 8Core32GB |
弹性模式用的存储资源规格,用于数据读写,增加该资源能提高集群读写能力。 |
ExecutorCount | String | 1 |
弹性模式下集群使用的计算节点数量。 |
DBClusterId | String | am-bp163885f8q21**** |
集群ID。 |
ConnectionString | String | am-bp163885f8q21****.ads.aliyuncs.com |
集群的公网连接地址。 |
RdsInstanceId | String | rm-bp11q28kvl688**** |
同步源RDS实例ID。仅MySQL分析实例会返回该参数。更多详情,请参见MySQL分析实例简介。 |
DBClusterType | String | Common |
集群类型,取值说明:
|
CommodityCode | String | ads |
商品code,固定为ads。 |
ExpireTime | String | 2999-09-08T16:00:00Z |
集群到期时间,UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ,例如2999-09-08T16:00:00Z。 说明
|
DBNodeStorage | Long | 300 |
集群的存储空间,单位:GB。 |
DBNodeClass | String | E8 |
节点规格。 |
LockReason | String | instance_expired |
集群锁定原因。 说明 仅当集群被锁定时会返回该参数,固定为instance_expire。
|
VPCId | String | vpc-bp13h7uzhulpuxvnpXXXX |
专有网络(VPC)ID。 |
RegionId | String | cn-hangzhou |
集群所在的地域ID。 |
ComputeResource | String | 8Core32GB |
弹性模式下使用的计算资源规格,用于数据计算。增加计算资源能加快查询速度,可以根据集群实际性能按需弹性扩缩。 |
ElasticIOResource | Integer | 0 |
弹性IO资源(Elastic IO Unit,简称EIU),更多详情,请参见EIU详解。 说明 仅弹性模式集群会返回该参数。
|
VSwitchId | String | vsw-bp1syh8vvw8yech7nXXXX |
交换机ID。 |
DBVersion | String | 3.0 |
数据库版本,当前仅支持3.0版本。 |
VPCCloudInstanceId | String | am-bp163885f8q21****-controller |
VPC实例ID。 |
DBClusterStatus | String | Running |
集群状态。更多详情,请参见集群状态表。 |
ResourceGroupId | String | rg-acfmyiu4ekp**** |
资源组ID。 |
DBClusterNetworkType | String | vpc |
集群网络类型。仅支持VPC(专有网络)类型。 |
DBClusterDescription | String | adb_test |
集群的描述信息。 |
ZoneId | String | cn-hangzhou-h |
集群所在的可用区ID。 |
Category | String | MIXED_STORAGE |
产品系列,取值说明:
说明 更多关于集群系列的介绍,请参见产品系列。
|
Engine | String | AnalyticDB |
集群引擎,固定为AnalyticDB。 |
InnerIp | String | 10.1.xx.xx |
公网IP。 |
InnerPort | String | 3306 |
端口号。 |
示例
请求示例
http(s)://adb.aliyuncs.com/?Action=DescribeDBClusters
&RegionId=cn-hangzhou
&DBClusterIds=am-bp1r053byu48p****
&DBClusterDescription=test
&DBClusterStatus=Running
&PageSize=30
&PageNumber=1
&ResourceGroupId=rg-4690g37929XXXX
&Tag=[{"Key":"tag1","Value":"test1"}]
&DBVersion=3.0
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBClustersResponse>
<TotalCount>1</TotalCount>
<PageSize>30</PageSize>
<RequestId>D65A809F-34CE-4550-9BC1-0ED21ETG380</RequestId>
<PageNumber>1</PageNumber>
<Items>
<DtsJobId>dtsb1578j90XXXX</DtsJobId>
<DBNodeCount>1</DBNodeCount>
<Expired>false</Expired>
<CreateTime>2021-04-01T09:50:18Z</CreateTime>
<PayType>Postpaid</PayType>
<DiskType>cloud_essd</DiskType>
<Tags>
<Key>tag1</Key>
<Value>test1</Value>
</Tags>
<Mode>flexible</Mode>
<Port>3306</Port>
<LockMode>Unlock</LockMode>
<StorageResource>8Core32GB</StorageResource>
<ExecutorCount>1</ExecutorCount>
<DBClusterId>am-bp163885f8q21****</DBClusterId>
<ConnectionString>am-bp163885f8q21****.ads.aliyuncs.com</ConnectionString>
<RdsInstanceId>rm-bp11q28kvl688****</RdsInstanceId>
<DBClusterType>Common</DBClusterType>
<CommodityCode>ads</CommodityCode>
<ExpireTime>2999-09-08T16:00:00Z</ExpireTime>
<DBNodeStorage>300</DBNodeStorage>
<DBNodeClass>E8</DBNodeClass>
<LockReason>instance_expired</LockReason>
<VPCId>vpc-bp13h7uzhulpuxvnpXXXX</VPCId>
<RegionId>cn-hangzhou</RegionId>
<ComputeResource>8Core32GB</ComputeResource>
<ElasticIOResource>0</ElasticIOResource>
<VSwitchId>vsw-bp1syh8vvw8yech7nXXXX</VSwitchId>
<DBVersion>3.0</DBVersion>
<VPCCloudInstanceId>am-bp163885f8q21****-controller</VPCCloudInstanceId>
<DBClusterStatus>Running</DBClusterStatus>
<ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
<DBClusterNetworkType>vpc</DBClusterNetworkType>
<DBClusterDescription>adb_test</DBClusterDescription>
<ZoneId>cn-hangzhou-h</ZoneId>
<Category>MIXED_STORAGE</Category>
<Engine>AnalyticDB</Engine>
<InnerIp>10.1.xx.xx</InnerIp>
<InnerPort>3306</InnerPort>
</Items>
</DescribeDBClustersResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 1,
"PageSize" : 30,
"RequestId" : "D65A809F-34CE-4550-9BC1-0ED21ETG380",
"PageNumber" : 1,
"Items" : [ {
"DtsJobId" : "dtsb1578j90XXXX",
"DBNodeCount" : 1,
"Expired" : "false",
"CreateTime" : "2021-04-01T09:50:18Z",
"PayType" : "Postpaid",
"DiskType" : "cloud_essd",
"Tags" : [ {
"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"
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | An error occurred while processing your request. | 系统内部错误,请稍后重试 |
503 | ServiceUnavailable | An error occurred while processing your request. | 系统暂时不可用,请稍后重试 |
访问错误中心查看更多错误码。