You can call this operation to query the details of an AnalyticDB for MySQL cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBClusterAttribute

The operation that you want to perform. Set this parameter to DescribeDBClusterAttribute.

DBClusterId String Yes rm-uf6wjk5xxxxxxxxxx

The ID of the cluster.

Response parameters

Parameter Type Example Description
Items Array of DBCluster

The list of clusters.

DBCluster
Category String Basic

The ApsaraDB RDS edition of the cluster. Valid values:

  • Basic
  • Cluster
  • MixedStorage: Cluster Edition (new)
CommodityCode String AnalyticDB for MySQL

N/A

ComputeResource String 24Core192GB

The specifications of computing resources in elastic mode. The increase of resources can speed up queries. AnalyticDB for MySQL automatically scales computing resources. For more information.

ConnectionString String am-xxxxxxxxxx.ads.aliyuncs.com

The endpoint of the cluster.

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

The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2011-05-30T12:11:4Z.

DBClusterDescription String testdatabase

The description of the cluster.

DBClusterId String rm-uf6wjk5xxxxxxxxxx

The ID of the cluster.

DBClusterNetworkType String vpc

The type of the network. VPC

DBClusterStatus String Running

The status of the cluster. For more information, see Cluster status.

DBClusterType String Primary

The type of the PolarDB-X cluster. Valid values:

  • Common
  • RdsAnalysis
DBNodeClass String C8

The specification of the node.

DBNodeCount Long 8

The number of node groups.

DBNodeStorage Long 100

The storage space of the node. Unit: GiB.

DBVersion String 3.0

The version of the cluster. Only version 3.0 is available.

DiskType String cloud

The type of the disk. Valid values:

  • cloud: basic disk
  • cloud_ssd: standard SSD
  • cloud_efficiency: ultra disk
  • cloud_essd: enhanced SSDs (ESSDs) at performance level 1. For more information, see ESSDs.
  • cloud_essd2: ESSDs at performance level 2. For more information, see ESSDs.
  • cloud_essd3: ESSDs at performance level 3. For more information, see ESSDs.
DtsJobId String dtsb1xxxxxxxxxx

The ID of the data synchronization task in Data Transmission Service (DTS). This parameter is valid only for analytic clusters.

ElasticIOResource Integer 0

An elastic I/O resource. This parameter only in elastic mode has a value.

Engine String AnalyticDB

The engine of the database. Valid value: AnalyticDB.

EngineVersion String 3.0

The engine version of the cluster.

ExecutorCount String 3

The number of nodes. The node resources are used for data computing in elastic mode.

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

The time when the cluster expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2011-05-30T12:11:4Z.

Note If the billing method of a cluster is pay-as-you-go, the cluster never expires.
Expired String false

Indicates whether the cluster has expired. Valid values:

  • true: The cluster has expired.
  • false: The cluster has not expired.
LockMode String Unlock

The lock mode of the cluster. Valid values:

  • Unlock: The cluster is unlocked.
  • ManualLock: The cluster is manually locked.
  • LockByExpiration: The cluster is automatically locked because it has expired.
  • LockByRestoration: The cluster is automatically locked for a rollback.
  • LockByDiskQuota: The cluster is automatically locked because the disk space is used up.
LockReason String instance_expired

The reason why the cluster is locked.

MaintainTime String 00:00Z-02:00Z

The time when the cluster can be maintained. The time follows the ISO 8601 standard in the HH:mmZ-HH:mmZ format. For example, 00:00Z-01:00Z indicates that routine maintenance can be performed from 00:00 to 01:00.

Mode String flexible

The mode of the cluster. Valid values:

  • flexible: the elastic mode
  • reserver: the reserved mode
PayType String Postpaid

The billing method of the cluster. Valid values:

  • Postpaid: pay-as-you-go
  • Prepaid: subscription
Port Integer 3306

The port that is used to access the cluster.

RdsInstanceId String rm-bp1oxxxxxxxxxx

The ID of the ApsaraDB RDS instance from which data is synchronized to the cluster. This parameter is valid only for analytic clusters.

RegionId String cn-hangzhou

The region ID of the cluster.

ResourceGroupId String rg-rexxxxxxxxxx

The ID of the resource group.

StorageResource String 24Core192GB

The specifications of storage resources in elastic mode. The resources are used for data read and write operations. The increase of resources can improve the read and write performance of your cluster. For more information.

Tags Array of Tag

A list of tags.

Tag
Key String test

The key of the resource tag.

Value String api

The tag value.

VPCCloudInstanceId String vpc-23rsxdfxxxxxxx

The ID that is assigned by the virtual private cloud (VPC) to the cluster.

VPCId String vpc-xxxxxxxxx

The ID of the VPC to which created clusters belong.

VSwitchId String vsw-xxxxxx

The ID of the vSwitch to which the cluster is connected.

ZoneId String cn-hangzhou-a

The IDs of zones.

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDBClusterAttribute
&DBClusterId=rm-uf6wjk5xxxxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<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>testdatabase</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 format

{
    "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": "testdatabase",
                "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"
                    }
                }
            }
        ]
    }
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified cluster ID does not exist. Check whether you specify the cluster ID value correctly.

For a list of error codes, visit the API Error Center.