All Products
Search
Document Center

PolarDB:DescribeDBClustersWithBackups

Last Updated:Jun 17, 2024

Queries the information about PolarDB clusters that contain backup sets in a region.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
polardb:DescribeDBClustersWithBackupsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

The ID of the resource group.

rg-************
RegionIdstringYes

The region ID of the cluster.

Note You can call the DescribeRegions operation to query information about regions.
cn-hangzhou
DBClusterIdsstringNo

The ID of the cluster. If you need to specify multiple cluster IDs, separate the cluster IDs with commas (,).

pc-**************
DBClusterDescriptionstringNo

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.
test
DBTypestringNo

The type of the database engine. Valid values:

  • MySQL
  • PostgreSQL
  • Oracle
MySQL
IsDeletedintegerNo

Specifies whether the cluster is deleted. Valid values:

  • 0: not deleted
  • 1: deleted
0
PageSizeintegerNo

The number of entries to return on each page. Valid values:

  • 30
  • 50
  • 100

Default value: 30.

30
PageNumberintegerNo

The number of the page to return. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1.

1
DBVersionstringNo

The version of the database engine.

  • Valid values for the MySQL database engine:

    • 5.6
    • 5.7
    • 8.0
  • Valid values for the PostgreSQL database engine:

    • 11
    • 14
  • Valid value for the Oracle database engine: 11

8.0

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

F8529AA2-522F-4B30-B80B-8F7D39******
PageNumberinteger

The total number of returned pages.

1
PageRecordCountinteger

The number of clusters returned per page.

1
TotalRecordCountinteger

The total number of returned entries.

1
Itemsobject []

The details about the cluster.

DeletedTimestring

The time when the cluster was deleted.

2022-05-12T03:25:37Z
VpcIdstring

The VPC ID of the cluster.

vpc-******************
ExpireTimestring

The time when the cluster expires.

Note A specific value will be returned only for subscription clusters. For pay-as-you-go clusters, an empty string will be returned.
2022-09-14T16:00:00Z
Expiredstring

Indicates whether the cluster has expired.

Note A specific value will be returned only for subscription clusters.
false
CreateTimestring

The time when the cluster was created.

2022-05-09T09:33:51Z
DBNodeClassstring

The specifications of the node.

polar.mysql.x4.medium
PayTypestring

The billing method. Valid values:

  • Postpaid: pay-as-you-go.
  • Prepaid: subscription
Postpaid
DBTypestring

The type of the database engine.

MySQL
LockModestring

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.
Unlock
RegionIdstring

The region ID of the cluster.

cn-hangzhou
DeletionLockinteger

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.
0
DBVersionstring

The version of the database engine.

8.0
DBClusterIdstring

The ID of cluster.

pc-****************
DBClusterStatusstring

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 specifications of the node are 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.
Running
IsDeletedinteger

Indicates whether the cluster was released. Valid values:

  • 1: released
  • 0: not released
1
DBClusterNetworkTypestring

The network type of the cluster.

VPC
DBClusterDescriptionstring

The name of the cluster.

test
ZoneIdstring

The ID of the zone in which the instance is located.

cn-hangzhou-h
Enginestring

The type of the database engine.

POLARDB

Examples

Sample success responses

JSONformat

{
  "RequestId": "F8529AA2-522F-4B30-B80B-8F7D39******",
  "PageNumber": 1,
  "PageRecordCount": 1,
  "TotalRecordCount": 1,
  "Items": {
    "DBCluster": [
      {
        "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 codeError codeError messageDescription
400InvalidRegionId.MalformedThe specified parameter RegionId is not valid.The specified RegionId parameter is invalid.
400InvalidPageSize.MalformedThe specified parameter PageSize is not valid.The specified PageSize parameter is invalid.
400InvalidPageNumber.MalformedThe specified parameter PageNumber is not valid.The specified PageNumber parameter is invalid.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.The request failed to be processed because unknown errors, exceptions, or failures have occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.A temporary server error occurred.

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

Change history

Change timeSummary of changesOperation
No change history