You can call this operation to query the list of backup plans.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeBackupPlans |
The operation that you want to perform. Set the value to DescribeBackupPlans |
ClusterId | String | Yes | cds-bp1yt5g0****7f48 |
The ID of the cluster for the backup. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
BackupPlans | Array |
The list of backup plans. |
|
BackupPlan | |||
Active | Boolean | true |
Indicates whether the backup plan is activated. |
BackupPeriod | String | Monday |
The backup cycle. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday. |
BackupTime | String | 00:30Z |
The start time of the backup task each day. The time follows the ISO 8601 standard in the HH:mmZ format. The time is displayed in UTC and denoted by Z. |
ClusterId | String | cds-uf6m0bod****6159 |
The ID of the cluster for the backup. |
CreatedTime | String | 2020-02-26T01:56Z |
The time when the backup plan was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC and denoted by Z. |
DataCenterId | String | cn-hangzhou-g |
The ID of the data center for the backup in the cluster. |
RetentionPeriod | Integer | 5 |
The duration for which you want to retain the backup. Valid values: 1 to 7. Unit: days. |
RequestId | String | 200FB963-9359-4CAD-90B7-96395C88FD9D |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeBackupPlans
&ClusterId=cds-bp1yt5g0****7f48
&<Common request parameters>
Sample success responses
XML
format
<DescribeBackupPlansResponse>
<RequestId>DBADCCEE-0E07-4DBD-9343-C7F312B23979</RequestId>
<BackupPlans>
<BackupPlan>
<DataCenterId>cn-shanghai-e</DataCenterId>
<BackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</BackupPeriod>
<Active>true</Active>
<CreatedTime>2020-02-26T01:56Z</CreatedTime>
<ClusterId>cds-uf6m0bod****6159</ClusterId>
<BackupTime>00:30Z</BackupTime>
<RetentionPeriod>7</RetentionPeriod>
</BackupPlan>
</BackupPlans>
</DescribeBackupPlansResponse>
JSON
format
{
"RequestId": "DBADCCEE-0E07-4DBD-9343-C7F312B23979",
"BackupPlans": {
"BackupPlan": [
{
"DataCenterId": "cn-shanghai-e",
"BackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
"Active": true,
"CreatedTime": "2020-02-26T01:56Z",
"ClusterId": "cds-uf6m0bod****6159",
"BackupTime": "00:30Z",
"RetentionPeriod": 7
}
]
}
}
Error codes
For a list of error codes, visit the API Error Center.