调用DescribeDBClusterAttribute接口查看AnalyticDB MySQL实例的详细信息。

调试

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

请求参数

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

系统规定参数,取值:DescribeDBClusterAttribute。

DBClusterId String rm-uf6wjk5xxxxxxxxxx

实例ID。

返回数据

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

实例列表。

DBCluster
Category String Basic

实例系列。Basic:基础版。

CommodityCode String AnalyticDB for MySQL

售卖商品Code。

ComputeResource String 24Core192GB

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

ConnectionString String am-xxxxxxxxxx.ads.aliyuncs.com

实例的地址。

CreationTime String 2011-05-30T12:11:04Z

实例创建时间,格式为yyyy-MM-dd’T’HH:mm:ss’Z’,例如2011-05-30T12:11:4Z。

DBClusterDescription String 测试数据库

实例描述。

DBClusterId String rm-uf6wjk5xxxxxxxxxx

实例ID。

DBClusterNetworkType String vpc

网络类型,默认vpc。

DBClusterStatus String Running

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

DBClusterType String Primary

实例类型。Common:主实例。

DBNodeClass String C8

节点类型,例如C8。

DBNodeCount Long 8

节点组个数。

DBNodeStorage Long 100

存储空间,单位:GB。

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。

EngineVersion String 3.0

引擎版本。

ExecutorCount String 3

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

ExpireTime String 2019-03-27T16:00:00Z

实例到期时间,格式为yyyy-MM-dd’T’HH:mm:ss’Z’,例如2011-05-30T12:11:4Z。

说明 按量付费实例无到期时间。
Expired String false

实例过期状态:

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

实例锁定模式:

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

锁定原因。

MaintainTime String 00:00Z-02:00Z

实例的可维护时间,格式为HH:mmZ- HH:mmZ,例如:00:00Z-01:00Z,表示0点到1点可进行例行维护。

Mode String flexible

模式:

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

付费类型:

  • Postpaid:按量付费;
  • Prepaid:预付费(包年包月)。
Port Integer 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

可用区。

RequestId String 05321590-BB65-4720-8CB6-8218E041CDD0

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDBClusterAttribute
&DBClusterId=rm-uf6wjk5xxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>
<Items>
    <DBCluster>
        <StorageResource>24Core192GB</StorageResource>
        <Category>Basic</Category>
        <ResourceGroupId>rg-rexxxxxxxxxx</ResourceGroupId>
        <Port>3306</Port>
        <DBClusterId>rm-uf6wjk5xxxxxxxxxx</DBClusterId>
        <DBClusterNetworkType>vpc</DBClusterNetworkType>
        <DBClusterType>Primary</DBClusterType>
        <ElasticIOResource>0</ElasticIOResource>
        <DiskType>cloud</DiskType>
        <DBVersion>3.0</DBVersion>
        <DtsJobId>dtsb1xxxxxxxxxx</DtsJobId>
        <CommodityCode>AnalyticDB for MySQL</CommodityCode>
        <DBNodeCount>8</DBNodeCount>
        <ExecutorCount>3</ExecutorCount>
        <LockReason>instance_expired</LockReason>
        <MaintainTime>00:00Z-02:00Z</MaintainTime>
        <Engine>AnalyticDB</Engine>
        <DBNodeStorage>100</DBNodeStorage>
        <EngineVersion>3.0</EngineVersion>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <VPCId>vpc-xxxxxxxxx</VPCId>
        <DBClusterStatus>Running</DBClusterStatus>
        <Mode>flexible</Mode>
        <VSwitchId>vsw-xxxxxx</VSwitchId>
        <DBClusterDescription>测试数据库</DBClusterDescription>
        <ComputeResource>24Core192GB</ComputeResource>
        <Expired>false</Expired>
        <PayType>Postpaid</PayType>
        <LockMode>Unlock</LockMode>
        <DBNodeClass>C8</DBNodeClass>
        <VPCCloudInstanceId>vpc-23rsxdfxxxxxxx</VPCCloudInstanceId>
        <CreationTime>2011-05-30T12:11:04Z</CreationTime>
        <RegionId>cn-hangzhou</RegionId>
        <ConnectionString>am-xxxxxxxxxx.ads.aliyuncs.com</ConnectionString>
        <ExpireTime>2019-03-27T16:00:00Z</ExpireTime>
        <RdsInstanceId>rm-bp1oxxxxxxxxxx</RdsInstanceId>
    </DBCluster>
    <DBCluster>
        <Tags>
            <Tag>
                <Value>api</Value>
                <Key>test</Key>
            </Tag>
        </Tags>
    </DBCluster>
</Items>

JSON 格式

{
    "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0",
    "Items": {
        "DBCluster": [
            {
                "StorageResource": "24Core192GB",
                "Category": "Basic",
                "ResourceGroupId": "rg-rexxxxxxxxxx",
                "Port": 3306,
                "DBClusterId": "rm-uf6wjk5xxxxxxxxxx",
                "DBClusterNetworkType": "vpc",
                "DBClusterType": "Primary",
                "ElasticIOResource": 0,
                "DiskType": "cloud",
                "DBVersion": 3,
                "DtsJobId": "dtsb1xxxxxxxxxx",
                "CommodityCode": "AnalyticDB for MySQL",
                "DBNodeCount": 8,
                "ExecutorCount": 3,
                "LockReason": "instance_expired",
                "MaintainTime": "00:00Z-02:00Z",
                "Engine": "AnalyticDB",
                "DBNodeStorage": 100,
                "EngineVersion": 3,
                "ZoneId": "cn-hangzhou-a",
                "VPCId": "vpc-xxxxxxxxx",
                "DBClusterStatus": "Running",
                "Mode": "flexible",
                "VSwitchId": "vsw-xxxxxx",
                "DBClusterDescription": "测试数据库",
                "ComputeResource": "24Core192GB",
                "Expired": false,
                "PayType": "Postpaid",
                "LockMode": "Unlock",
                "DBNodeClass": "C8",
                "VPCCloudInstanceId": "vpc-23rsxdfxxxxxxx",
                "CreationTime": "2011-05-30T12:11:04Z",
                "RegionId": "cn-hangzhou",
                "ConnectionString": "am-xxxxxxxxxx.ads.aliyuncs.com",
                "ExpireTime": "2019-03-27T16:00:00Z",
                "RdsInstanceId": "rm-bp1oxxxxxxxxxx"
            },
            {
                "Tags": {
                    "Tag": {
                        "Value": "api",
                        "Key": "test"
                    }
                }
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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