DescribeDBClustersWithBackups - PolarDB - Alibaba Cloud Documentation Center

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	DescribeDBClustersWithBackups	The operation that you want to perform. Set the value to DescribeDBClustersWithBackups.
ResourceGroupId	String	No	rg-************	The ID of the resource group.
RegionId	String	Yes	cn-hangzhou	The region ID of the cluster. Note You can call the DescribeRegions operation to query information about regions.
DBClusterIds	String	No	pc-**************	The ID of the PolarDB cluster. If you need to specify multiple cluster IDs, separate the cluster IDs with commas (,).
DBClusterDescription	String	No	test	The name of the cluster. The name must meet the following requirements: It cannot start with `http://` or `https://`. It must be 2 to 256 characters in length.
DBType	String	No	MySQL	The type of the engine. Valid values: MySQL PostgreSQL Oracle
IsDeleted	Integer	No	0	Specifies whether the cluster is deleted. Valid values: 0: not deleted 1: deleted
PageSize	Integer	No	30	The number of entries to return on each page. Valid values: 30 50 100 Default value: 30.
PageNumber	Integer	No	1	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.
DBVersion	String	No	8.0	The version of the engine. Valid values for the MySQL engine: 5.6 5.7 8.0 Valid values for the PostgreSQL engine: 11 and 14 Valid value for the Oracle engine: 11

Response parameters


Parameter	Type	Example	Description
RequestId	String	F8529AA2-522F-4B30-B80B-8F7D39******	The ID of the request.
PageNumber	Integer	1	The number of returned pages.
PageRecordCount	Integer	1	The number of clusters returned per page.
TotalRecordCount	Integer	1	The total number of entries.
Items	Array of DBCluster		The details about the cluster.
DBCluster
DeletedTime	String	2022-05-12T03:25:37Z	The time when the cluster was deleted.
VpcId	String	vpc-******************	The VPC ID of the cluster.
ExpireTime	String	2022-09-14T16:00:00Z	The expiration time. Note A specific value will be returned only for subscription clusters. For pay-as-you-go clusters, an empty string will be returned.
Expired	String	false	Indicates whether the cluster has expired. Note A specific value will be returned only for subscription clusters.
CreateTime	String	2022-05-09T09:33:51Z	The time when the cluster was created.
DBNodeClass	String	polar.mysql.x4.medium	The instance type of the node.
PayType	String	Postpaid	The billing method of the cluster. Valid values: Postpaid: The cluster uses the pay-as-you-go billing method. Prepaid: The cluster uses the subscription billing method.
DBType	String	MySQL	The type of the engine.
LockMode	String	Unlock	The state of the cluster lock. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked after the cluster expires.
RegionId	String	cn-hangzhou	The region ID of the cluster.
DeletionLock	Integer	0	Indicates whether the cluster is locked and can be deleted. Valid values: 0: The cluster is not locked and can be deleted. 1: The cluster is locked and cannot be deleted.
DBVersion	String	8.0	The version of the engine.
DBClusterId	String	pc-****************	The ID of the cluster.
DBClusterStatus	String	Running	The status of the cluster. Valid values: Creating: The cluster is being created. Running: The cluster is running. Deleting: The cluster is being released. Rebooting: The cluster is restarting. DBNodeCreating: The node is being added. DBNodeDeleting: The node is being deleted. ClassChanging: The node specification is being changed. NetAddressCreating: The network connection is being created. NetAddressDeleting: The network connection is being deleted. NetAddressModifying: The network connection is being modified. Deleted: The cluster has been released.
IsDeleted	Integer	1	Indicates whether the cluster was released. Valid values: 1: released 0: not released
DBClusterNetworkType	String	VPC	The network type of the cluster.
DBClusterDescription	String	test	The name of the cluster.
ZoneId	String	cn-hangzhou-h	The zone ID of the cluster.
Engine	String	POLARDB	The cluster engine.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClustersWithBackups
&ResourceGroupId=rg-************
&RegionId=cn-hangzhou
&DBClusterIds=pc-**************
&DBClusterDescription=test
&DBType=MySQL
&IsDeleted=0
&PageSize=30
&PageNumber=1
&DBVersion=8.0
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClustersWithBackupsResponse>
    <RequestId>F8529AA2-522F-4B30-B80B-8F7D39******</RequestId>
    <PageNumber>1</PageNumber>
    <PageRecordCount>1</PageRecordCount>
    <TotalRecordCount>1</TotalRecordCount>
    <Items>
        <DeletedTime>2022-05-12T03:25:37Z</DeletedTime>
        <VpcId>vpc-******************</VpcId>
        <ExpireTime>2022-09-14T16:00:00Z</ExpireTime>
        <Expired>false</Expired>
        <CreateTime>2022-05-09T09:33:51Z</CreateTime>
        <DBNodeClass>polar.mysql.x4.medium</DBNodeClass>
        <PayType>Postpaid</PayType>
        <DBType>MySQL</DBType>
        <LockMode>Unlock</LockMode>
        <RegionId>cn-hangzhou</RegionId>
        <DeletionLock>0</DeletionLock>
        <DBVersion>8.0</DBVersion>
        <DBClusterId>pc-****************</DBClusterId>
        <DBClusterStatus>Running</DBClusterStatus>
        <IsDeleted>1</IsDeleted>
        <DBClusterNetworkType>VPC</DBClusterNetworkType>
        <DBClusterDescription>test</DBClusterDescription>
        <ZoneId>cn-hangzhou-h</ZoneId>
        <Engine>POLARDB</Engine>
    </Items>
</DescribeDBClustersWithBackupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "F8529AA2-522F-4B30-B80B-8F7D39******",
  "PageNumber" : 1,
  "PageRecordCount" : 1,
  "TotalRecordCount" : 1,
  "Items" : [ {
    "DeletedTime" : "2022-05-12T03:25:37Z",
    "VpcId" : "vpc-******************",
    "ExpireTime" : "2022-09-14T16:00:00Z",
    "Expired" : "false",
    "CreateTime" : "2022-05-09T09:33:51Z",
    "DBNodeClass" : "polar.mysql.x4.medium",
    "PayType" : "Postpaid",
    "DBType" : "MySQL",
    "LockMode" : "Unlock",
    "RegionId" : "cn-hangzhou",
    "DeletionLock" : 0,
    "DBVersion" : "8.0",
    "DBClusterId" : "pc-****************",
    "DBClusterStatus" : "Running",
    "IsDeleted" : 1,
    "DBClusterNetworkType" : "VPC",
    "DBClusterDescription" : "test",
    "ZoneId" : "cn-hangzhou-h",
    "Engine" : "POLARDB"
  } ]
}

Error codes


HTTP status code	Error code	Error message	Description
400	InvalidRegionId.Malformed	The specified parameter RegionId is not valid.	The error message returned because the specified RegionId parameter is invalid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The error message returned because the specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The error message returned because the specified PageNumber parameter is invalid.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	The error message returned because an internal error has occurred.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The error message returned because a temporary server failure has occurred.

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