调用DescribeDBClusterAttribute接口查看目标AnalyticDB MySQL版集群的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBClusterAttribute |
系统规定参数。取值:DescribeDBClusterAttribute。 |
DBClusterId | String | 是 | am-bp*************** |
集群ID。 说明 您可以调用DescribeDBClusters接口查看目标地域下所有AnalyticDB MySQL集群的详情,包括集群ID。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 2895BB82-B2C1-408E-AA73-DB8D59****** |
请求ID。 |
Items | Array of DBCluster |
集群信息列表。 |
|
DBCluster | |||
CreationTime | String | 2021-04-01T09:50:18Z |
集群创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间),例如2021-04-01T09:50:18Z。 |
EnableSpark | Boolean | false |
是否创建了Spark集群。取值说明:
|
DtsJobId | String | dtsb1*********** |
DTS同步任务ID。仅MySQL分析实例会返回该参数。 |
DBNodeCount | Long | 1 |
节点组个数。 |
Expired | String | false |
集群是否过期。取值说明:
|
MaintainTime | String | 04:00Z-05:00Z |
集群的可维护时间段(UTC时间),格式为HH:mmZ- HH:mmZ,例如:04:00Z-05:00Z,表示可维护时间段为4点至5点。 说明 更多关于可维护时间段的信息,请参见设置可维护时间段。
|
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 | Integer | 3306 |
集群端口号。 |
LockMode | String | Unlock |
集群的锁定模式,取值说明:
|
EngineVersion | String | 3.1.1.9 |
集群引擎版本。 |
EnableAirflow | Boolean | true |
是否创建了Airflow集群。取值说明:
|
ExecutorCount | String | 1 |
弹性模式下集群使用的计算节点数量。 |
StorageResource | String | 8Core32GB |
弹性模式用的存储资源规格,用于数据读写,增加该资源能提高集群读写能力。 |
DBClusterId | String | am-bp*************** |
集群ID。 |
ConnectionString | String | am-bp**********************.ads.aliyuncs.com |
集群的VPC连接地址。 |
RdsInstanceId | String | rm-bp************* |
同步源RDS实例ID。仅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。 说明
|
DBNodeStorage | Long | 300 |
集群的存储空间,单位:GB。 |
DBNodeClass | String | E8 |
节点规格。 |
LockReason | String | instance_expired |
集群锁定原因。 说明 仅当集群被锁定时会返回该参数,固定为instance_expire。
|
VPCId | String | vpc-bp****************** |
专有网络(VPC)ID。 |
ComputeResource | String | 8Core32GB |
弹性模式下使用的计算资源规格,用于数据计算。增加计算资源能加快查询速度,可以根据集群实际性能按需弹性扩缩。 |
RegionId | String | cn-hangzhou |
集群所在的地域ID。 |
ElasticIOResource | Integer | 0 |
弹性IO资源(Elastic IO Unit,简称EIU),更多详情,请参见EIU详解。 说明 仅弹性模式集群会返回该参数。
|
VSwitchId | String | vsw-bp****************** |
交换机ID。 |
DBVersion | String | 3.0 |
数据库版本,当前仅支持3.0版本。 |
VPCCloudInstanceId | String | am-bp**************-controller |
VPC实例ID。 |
DBClusterStatus | String | Running |
集群状态。更多详情,请参见集群状态表。 |
ResourceGroupId | String | rg-ac************* |
资源组ID。 |
DBClusterNetworkType | String | vpc |
集群网络类型。仅支持VPC(专有网络)类型。 |
DBClusterDescription | String | adb_test |
集群的描述信息。 |
UserENIStatus | Boolean | true |
是否已启用ENI(Elastic Network Interface,弹性网卡)网络,取值说明:
|
ZoneId | String | cn-hangzhou-h |
集群所在的可用区ID。 |
Category | String | MIXED_STORAGE |
产品系列,取值说明:
说明 更多关于集群系列的介绍,请参见产品系列。
|
Engine | String | AnalyticDB |
集群引擎,固定为AnalyticDB。 |
KmsId | String | sdfsdfdsf-sdfsdfsdf-sdfsdf-sdfsdf |
用于加密云盘数据的密钥ID。 说明 仅当AnalyticDB MySQL集群开启云盘加密时才会返回该参数。
|
示例
请求示例
http(s)://adb.aliyuncs.com/?Action=DescribeDBClusterAttribute
&DBClusterId=am-bp***************
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBClusterAttributeResponse>
<RequestId>2895BB82-B2C1-408E-AA73-DB8D59******</RequestId>
<Items>
<DBCluster>
<StorageResource>8Core32GB</StorageResource>
<Category>MIXED_STORAGE</Category>
<ResourceGroupId>rg-ac*************</ResourceGroupId>
<Port>3306</Port>
<DBClusterId>am-bp***************</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/>
<MaintainTime>04:00Z-05:00Z</MaintainTime>
<Engine>AnalyticDB</Engine>
<Tags>
<Tag>
<Value>test1</Value>
<Key>tag1</Key>
</Tag>
</Tags>
<DBNodeStorage>300</DBNodeStorage>
<EngineVersion>3.1.4.6</EngineVersion>
<UserENIStatus>true</UserENIStatus>
<ZoneId>cn-hangzhou-h</ZoneId>
<VPCId>vpc-bp******************</VPCId>
<DBClusterStatus>Running</DBClusterStatus>
<VSwitchId>vsw-bp******************</VSwitchId>
<Mode>flexible</Mode>
<DBClusterDescription>adb_test</DBClusterDescription>
<ComputeResource>8Core32GB</ComputeResource>
<LockMode>Unlock</LockMode>
<PayType>Postpaid</PayType>
<DBNodeClass>E8</DBNodeClass>
<EnableSpark>false</EnableSpark>
<VPCCloudInstanceId>am-bp**************-controller</VPCCloudInstanceId>
<CreationTime>2021-04-01T09:50:18Z</CreationTime>
<RegionId>cn-hangzhou</RegionId>
<ExpireTime>2999-09-08T16:00:00Z</ExpireTime>
<ConnectionString>am-bp**********************.ads.aliyuncs.com</ConnectionString>
<RdsInstanceId/>
</DBCluster>
</Items>
</DescribeDBClusterAttributeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "2895BB82-B2C1-408E-AA73-DB8D59******",
"Items" : {
"DBCluster" : [ {
"StorageResource" : "8Core32GB",
"Category" : "MIXED_STORAGE",
"ResourceGroupId" : "rg-ac*************",
"Port" : "3306",
"DBClusterId" : "am-bp***************",
"DBClusterNetworkType" : "vpc",
"DBClusterType" : "Common",
"DiskType" : "cloud_essd",
"ElasticIOResource" : 0,
"DBVersion" : "3.0",
"DtsJobId" : "",
"DBNodeCount" : 1,
"CommodityCode" : "ads",
"ExecutorCount" : 1,
"LockReason" : "",
"MaintainTime" : "04:00Z-05:00Z",
"Engine" : "AnalyticDB",
"Tags" : {
"Tag" : [ {
"Value" : "test1",
"Key" : "tag1"
} ]
},
"DBNodeStorage" : 300,
"EngineVersion" : "3.1.4.6",
"UserENIStatus" : true,
"ZoneId" : "cn-hangzhou-h",
"VPCId" : "vpc-bp******************",
"DBClusterStatus" : "Running",
"VSwitchId" : "vsw-bp******************",
"Mode" : "flexible",
"DBClusterDescription" : "adb_test",
"ComputeResource" : "8Core32GB",
"LockMode" : "Unlock",
"PayType" : "Postpaid",
"DBNodeClass" : "E8",
"EnableSpark" : false,
"VPCCloudInstanceId" : "am-bp**************-controller",
"CreationTime" : "2021-04-01T09:50:18Z",
"RegionId" : "cn-hangzhou",
"ExpireTime" : "2999-09-08T16:00:00Z",
"ConnectionString" : "am-bp**********************.ads.aliyuncs.com",
"RdsInstanceId" : ""
} ]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。 |
访问错误中心查看更多错误码。