DescribeDBClusters - AnalyticDB for MySQL - Alibaba Cloud Documentation Center

Queries a list of AnalyticDB for MySQL clusters within a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the clusters. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBClusterIds	string	No	The cluster IDs. Note You can specify the ID of one cluster or IDs of more clusters within the preceding region.	am-bp1r053byu48p****
DBClusterDescription	string	No	The description of the cluster. The description cannot start with `http://` or `https://`. The description must be 2 to 256 characters in length	test
DBClusterStatus	string	No	The state of the cluster. Valid values: Preparing: The cluster is being prepared. Creating: The cluster is being created. Restoring: The cluster is being restored from a backup. Running: The cluster is running. Deleting: The cluster is being deleted. ClassChanging: The cluster specifications are being changed. NetAddressCreating: A network connection is being created. NetAddressDeleting: A network connection is being deleted.	Running
PageSize	integer	No	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
ResourceGroupId	string	No	The ID of the resource group.	rg-4690g37929XXXX
Tag	array<object>	No	The tags that are added to the cluster.
	object	No	The tag that is added to the cluster.
Key	string	No	The key of tag N that is added to the cluster. You can use tags to filter clusters. A tag is a key-value pair. You can specify up to 20 tags in one request. The letter N specifies the sequence number of each key-value pair and must be unique. The values of N must be consecutive integers that start from 1. Each value of `Tag.N.Key` is paired with a value of `Tag.N.Value`. Note The tag key can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.	tag1
Value	string	No	The value of tag N that is added to the cluster. You can use tags to filter clusters. A tag is a key-value pair. You can specify up to 20 tags in one request. The letter N specifies the sequence number of each key-value pair and must be unique. The values of N must be consecutive integers that start from 1. Each value of `Tag.N.Key` is paired with a value of `Tag.N.Value`. Note The tag key can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.	test1
DBVersion	string	No	The version of the cluster. Set the value to 3.0.	3.0

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries per page.	30
RequestId	string	The request ID.	D65A809F-34CE-4550-9BC1-0ED21ETG380
PageNumber	integer	The page number.	1
Items	array<object>	The queried clusters.
	object	The queried cluster.
DtsJobId	string	The ID of the Data Transmission Service (DTS) synchronization job. This parameter is returned only for MySQL analytic instances.	dtsb1578j90XXXX
DBNodeCount	long	The number of node groups.	1
Expired	string	Indicates whether the cluster has expired. Valid values: true false	false
CreateTime	string	The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Example: 2021-04-01T09:50:18Z.	2021-04-01T09:50:18Z
PayType	string	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
DiskType	string	The disk type of the cluster. Valid values: local_ssd: local SSD. cloud: basic disk. cloud_ssd: standard SSD. cloud_efficiency: ultra disk. cloud_essd0: PL0 Enterprise SSD (ESSD). cloud_essd: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. Note For more information about ESSDs, see ESSDs .	cloud_essd
Tags	array<object>	The tags that are added to the cluster.
	object	The tag that is added to the cluster.
Key	string	The tag key. Note You can call the TagResources operation to add a tag to the cluster.	tag1
Value	string	The tag value.	test1
Mode	string	The mode of the cluster. Valid values: flexible: elastic mode. reserver: reserved mode. Note For more information about cluster modes, see Editions .	flexible
Port	string	The port number that is used to connect to the cluster. Default value: 3306.	3306
LockMode	string	The lock mode of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked due to cluster expiration. LockByRestoration: The cluster is automatically locked due to cluster restoration. LockByDiskQuota: The cluster is automatically locked when 90% of the cluster storage is used.	Unlock
StorageResource	string	The specifications of storage resources that are used in the cluster in elastic mode. Storage resources are used to read and write data. The increase in the storage resources can improve the read and write performance of the cluster.	8Core32GB
ExecutorCount	string	The number of compute nodes that are used by the cluster in elastic mode.	1
DBClusterId	string	The cluster ID.	am-bp163885f8q21****
ConnectionString	string	The public endpoint that is used to connect to the cluster.	am-bp163885f8q21****.ads.aliyuncs.com
RdsInstanceId	string	The ID of the ApsaraDB RDS instance from which data is synchronized to the cluster. This parameter is returned only for MySQL analytic instances.	rm-bp11q28kvl688****
DBClusterType	string	The type of the cluster. Valid values: Common: common cluster. RDS_ANALYSIS: MySQL analytic instance.	Common
CommodityCode	string	The commodity code. ads is returned.	ads
ExpireTime	string	The expiration time of the cluster. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Example: 2999-09-08T16:00:00Z. Note If the billing method of the cluster is subscription, the actual expiration time is returned. If the billing method of the cluster is pay-as-you-go, 2999-09-08T16:00:00Z is returned.	2999-09-08T16:00:00Z
DBNodeStorage	long	The storage capacity of the cluster. Unit: GB.	300
DBNodeClass	string	The specifications of the cluster.	E8
LockReason	string	The reason why the cluster is locked. Note This parameter is returned only when the cluster was locked. instance_expire is returned.	instance_expired
VPCId	string	The virtual private cloud (VPC) ID of the cluster.	vpc-bp13h7uzhulpuxvnpXXXX
RegionId	string	The region ID of the cluster.	cn-hangzhou
ComputeResource	string	The specifications of computing resources that are used in the cluster in elastic mode. Computing resources are used to compute data. The increase in the computing resources can accelerate queries. You can scale computing resources based on your business requirements.	8Core32GB
ElasticIOResource	integer	The number of elastic I/O units (EIUs). For more information, see Elasticity of the storage layer. Note This parameter is returned only for clusters in elastic mode.	0
VSwitchId	string	The vSwitch ID of the cluster.	vsw-bp1syh8vvw8yech7nXXXX
DBVersion	string	The version of the database engine. 3.0 is returned.	3.0
VPCCloudInstanceId	string	The ID of the cluster that resides in the VPC.	am-bp163885f8q21****-controller
DBClusterStatus	string	The status of the cluster. For more information, see Cluster states.	Running
ResourceGroupId	string	The resource group ID.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	The network type of the cluster. VPC is returned.	vpc
DBClusterDescription	string	The description of the cluster.	adb_test
ZoneId	string	The zone ID of the cluster.	cn-hangzhou-h
Category	string	The edition of the cluster. Valid values: BASIC: reserved mode for Basic Edition. CLUSTER: reserved mode for Cluster Edition. MIXED_STORAGE: elastic mode for Cluster Edition. Note For more information about cluster editions, see Editions .	MIXED_STORAGE
Engine	string	The engine of the cluster. AnalyticDB is returned.	AnalyticDB
InnerIp	string	The public IP address of the cluster.	10.1.xx.xx
InnerPort	string	The port number that is used to connect to the cluster.	3306
TaskInfo	object	The job progress.
Name	string	The name of the job.	analyticDBFlexibleScaleOut
Status	string	The status of the job. Valid values: NOT_RUN RUNNING SUCCEED	RUNNING
Progress	string	The progress of the job. Unit: %.	10
StepList	array<object>	The job steps.
	object
StepName	string	The name of the job step.	ApplyResource
StepDesc	string	The description of the job step.	Apply resource
StepStatus	string	The status of the job step. Valid values: NOT_RUN RUNNING SUCCEED	SUCCEED
StepProgress	string	The progress of the job step. Unit: %.	50
StartTime	string	The start time of the job step. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2024-03-10T09:28:34Z
EndTime	string	The end time of the job step. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2024-03-10T10:28:34Z
ProductVersion	string	The edition of the cluster. Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	EnterpriseVersion

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "DtsJobId": "dtsb1578j90XXXX",
        "DBNodeCount": 1,
        "Expired": "false",
        "CreateTime": "2021-04-01T09:50:18Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "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",
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Apply resource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductVersion": "EnterpriseVersion"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An internal error occurred. Please try again later.
503	ServiceUnavailable	An error occurred while processing your request.	The system is unavailable. Please try again later.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-28	The Error code has changed. The response structure of the API has changed	View Change Details
2024-04-01	The Error code has changed. The response structure of the API has changed	View Change Details