Queries the information about PolarDB clusters that contain backup sets in a region.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| polardb:DescribeDBClustersWithBackups | Read |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ResourceGroupId | string | No | The ID of the resource group. | rg-************ |
| RegionId | string | Yes | The region ID of the cluster. Note
You can call the DescribeRegions operation to query information about regions.
| cn-hangzhou |
| DBClusterIds | string | No | The ID of the cluster. If you need to specify multiple cluster IDs, separate the cluster IDs with commas (,). | pc-************** |
| DBClusterDescription | string | No | The name of the cluster. The name must meet the following requirements:
| test |
| DBType | string | No | The type of the database engine. Valid values:
| MySQL |
| IsDeleted | integer | No | Specifies whether the cluster is deleted. Valid values:
| 0 |
| PageSize | integer | No | The number of entries to return on each page. Valid values:
Default value: 30. | 30 |
| PageNumber | integer | No | 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 |
| DBVersion | string | No | The version of the database engine.
| 8.0 |
Response parameters
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 code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidRegionId.Malformed | The specified parameter RegionId is not valid. | The specified RegionId parameter is invalid. |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | The specified PageSize parameter is invalid. |
| 400 | InvalidPageNumber.Malformed | The specified parameter PageNumber is not valid. | The specified PageNumber parameter is invalid. |
| 500 | InternalError | The 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. |
| 503 | ServiceUnavailable | The 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 time | Summary of changes | Operation |
|---|