Use DescribeDBClusters to query AnalyticDB for MySQL clusters - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries Data Warehouse Edition clusters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeDBClusters

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Note You can call the DescribeRegions operation to query the region IDs of available regions.	cn-hangzhou
DBClusterIds	string	No	The cluster IDs. Note You can enter any cluster ID in the specified region.	am-bp1r053byu48p****
DBClusterDescription	string	No	The cluster description. It cannot start with `http://` or `https://`. It must be 2 to 256 characters in length.	test
DBClusterStatus	string	No	The cluster status. Valid values: Preparing: preparing Creating: creating Restoring: restoring from a backup Running: running Deleting: deleting ClassChanging: changing specifications NetAddressCreating: creating a network address NetAddressDeleting: deleting a network address	Running
PageSize	integer	No	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	No	The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.	1
ResourceGroupId	string	No	The resource group ID.	rg-4690g37929XXXX
Tag	array<object>	No	The list of tags.
	object	No	The tag details.
Key	string	No	The tag key. You can filter the cluster list by tag. You can specify up to 20 tag key-value pairs. The number N in each tag key-value pair must be unique and must be a consecutive integer starting from 1. The value of Tag.N.Key corresponds to the 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 tag value. You can filter the cluster list by tag. You can specify up to 20 tag key-value pairs. The number N in each tag key-value pair must be unique and must be a consecutive integer starting from 1. The value of Tag.N.Key corresponds to the value of Tag.N.Value. Note The tag value can be up to 64 characters in length and cannot start with `aliyun`, `acs:`, `http://`, or `https://`.	test1
DBVersion	string	No	The cluster version. Set the value to 3.0.	3.0
DBClusterVersion	string	No	The cluster edition. Valid values: 3.0: Data Warehouse Edition. 5.0 (default): Data Lakehouse Edition, Enterprise Edition, and Basic Edition. All: all editions, including Data Warehouse Edition, Data Lakehouse Edition, Enterprise Edition, and Basic Edition. Valid values: All : all editions, including Data Warehouse Edition, Data Lakehouse Edition, Enterprise Edition, and Basic Edition. 3.0 : Data Warehouse Edition. 5.0 : Data Lakehouse Edition, Enterprise Edition, and Basic Edition.	3.0

Response elements

Element	Type	Description	Example
	object	The list details.
TotalCount	integer	The total number of records.	1
PageSize	integer	The number of records per page.	30
RequestId	string	The request ID.	D65A809F-34CE-4550-9BC1-0ED21ETG380
PageNumber	integer	The page number.	1
Items	object
DBCluster	array<object>	The list of cluster information.
	array<object>	The tag details.
DtsJobId	string	The ID of the Data Transmission Service (DTS) synchronization task. This parameter is returned only for MySQL analytic instances.	dtsb1578j90XXXX
DBNodeCount	integer	The number of node groups.	1
Expired	string	Indicates whether the cluster has expired. Valid values: true: The cluster has expired. false: The cluster has not expired.	false
CreateTime	string	The time when the cluster was created. The time is displayed in UTC in the yyyy-MM-ddTHH:mm:ssZ format. 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 disk. cloud: basic disk. cloud_ssd: standard SSD. cloud_efficiency: ultra disk. cloud_essd0: PL0 ESSD. cloud_essd: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. Note For more information about ESSDs, see ESSD specifications.	cloud_essd
Tags	object
Tag	array<object>	The list of tags.
	object	The tag details.
Key	string	The tag key. Note You can call the TagResources operation to create tags for the cluster.	tag1
Value	string	The tag value.	test1
Mode	string	The cluster mode. Valid values: flexible: Elastic mode. reserver: Reserved mode. Note For more information about cluster modes, see Editions.	flexible
Port	string	The port number of 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 expiration. LockByRestoration: The cluster is automatically locked before a rollback. LockByDiskQuota: The cluster is automatically locked because the storage space is full. This occurs when the storage space used by data reaches 90% of the upper limit.	Unlock
StorageResource	string	The storage resource specification used in elastic mode for data reads and writes. Increasing this resource improves the read and write capabilities of the cluster.	8Core32GB
ExecutorCount	string	The number of compute nodes used by the cluster in elastic mode.	1
DBClusterId	string	The cluster ID.	am-bp163885f8q21****
ConnectionString	string	The public endpoint of the cluster.	am-bp163885f8q21****.ads.aliyuncs.com
RdsInstanceId	string	The instance ID of the source ApsaraDB RDS instance for synchronization. This parameter is returned only for MySQL analytic instances.	rm-bp11q28kvl688****
DBClusterType	string	The cluster type. Valid values: Common: common cluster. RDS_ANALYSIS: MySQL analytic instance.	Common
CommodityCode	string	The commodity code. The value is fixed as ads.	ads
ExpireTime	string	The expiration time of the cluster. The time is displayed in UTC in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2999-09-08T16:00:00Z. Note If the cluster uses the subscription billing method, the actual expiration time is returned. If the cluster uses the pay-as-you-go billing method, the fixed value 2999-09-08T16:00:00Z is returned.	2999-09-08T16:00:00Z
DBNodeStorage	integer	The storage space of the cluster. Unit: GB.	300
DBNodeClass	string	The node specifications.	E8
LockReason	string	The reason why the cluster is locked. Note This parameter is returned only when the cluster is locked. The value is fixed as instance_expire.	instance_expired
VPCId	string	The virtual private cloud (VPC) ID.	vpc-bp13h7uzhulpuxvnpXXXX
RegionId	string	The region ID of the cluster.	cn-hangzhou
ComputeResource	string	The compute resource specification used in elastic mode for data computing. Increasing compute resources accelerates query speeds. You can scale compute resources elastically based on the actual performance requirements of the cluster.	8Core32GB
ElasticIOResource	integer	The elastic I/O resource (EIU). For more information, see EIU overview. Note This parameter is returned only for clusters in elastic mode.	0
VSwitchId	string	The vSwitch ID.	vsw-bp1syh8vvw8yech7nXXXX
DBVersion	string	The database engine version. Only version 3.0 is supported.	3.0
VPCCloudInstanceId	string	The VPC-connected instance ID.	am-bp163885f8q21****-controller
DBClusterStatus	string	The cluster status. For more information, see Cluster status.	Running
ResourceGroupId	string	The resource group ID.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	The network type of the cluster. Only VPC is supported.	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. Valid values: BASIC: Basic Edition in reserved mode. CLUSTER: Cluster Edition in reserved mode. MIXED_STORAGE: Cluster Edition in elastic mode. Note For more information about editions, see Editions.	MIXED_STORAGE
Engine	string	The database engine of the cluster. The value is fixed as AnalyticDB.	AnalyticDB
InnerIp	string	The public IP address.	10.1.xx.xx
InnerPort	string	The port number.	3306
TaskInfo	object	The task progress information.
Name	string	The task name.	analyticDBFlexibleScaleOut
Status	string	The task status. Valid values: NOT_RUN: The task is waiting to run. RUNNING: The task is running. SUCCEED: The task is completed. Valid values: SUCCEED : Completed. RUNNING : Running. NOT_RUN : Waiting to run.	RUNNING
Progress	string	The task progress. Unit: %.	10
StepList	object
StepList	array<object>	The task steps.
	object	The task steps.
StepName	string	The step name.	ApplyResource
StepDesc	string	The step description.	Apply resource
StepStatus	string	The step status. Valid values: NOT_RUN: The step is waiting to run. RUNNING: The step is running. SUCCEED: The step is completed. Valid values: SUCCEED : Completed. RUNNING : Running. NOT_RUN : Waiting to run.	SUCCEED
StepProgress	string	The step progress. Unit: %.	50
StartTime	string	The start time of the step. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.	2024-03-10T09:28:34Z
EndTime	string	The end time of the step. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.	2024-03-10T10:28:34Z
ProductVersion	string	The product edition. Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	EnterpriseVersion

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.