You can call this operation to query backup plans.

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 DescribeBackupPlan

The operation that you want to perform. Set the value to DescribeBackupPlan.

ClusterId String Yes cds-uf6m0bo****6158

The ID of the cluster for the backup.

DataCenterId String Yes cn-shanghai-e

The ID of the data center for the backup in the cluster.

Response parameters

Parameter Type Example Description
BackupPlan Struct

The details of the backup plan.

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 time when the backup task starts each day. The time is displayed in UTC and denoted by Z.

ClusterId String cds-uf6m0b****7v6159

The ID of the cluster for the backup.

CreatedTime String 2020-02-26T01:56Z

The time when the backup plan was created. The time is displayed in UTC and denoted by Z.

DataCenterId String cn-shanghai-e

The ID of the data center for the backup in the cluster.

RetentionPeriod Integer 7

The duration for which you want to retain the backup. Valid values: 1 to 7. Unit: days.

RequestId String 0EA95AA2-860C-42CB-97CF-78CA3937E0D5

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeBackupPlan
&ClusterId=cds-uf6m0bo****6158
&DataCenterId=cn-shanghai-e
&<Common request parameters>

Sample success responses

XML format

<DescribeBackupPlanResponse>
      <RequestId>0EA95AA2-860C-42CB-97CF-78CA3937E0D5</RequestId>
      <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-uf6m0bo****v6159</ClusterId>
            <BackupTime>00:30Z</BackupTime>
            <RetentionPeriod>7</RetentionPeriod>
      </BackupPlan>
</DescribeBackupPlanResponse>

JSON format

{
  "RequestId": "0EA95AA2-860C-42CB-97CF-78CA3937E0D5",
  "BackupPlan": {
    "DataCenterId": "cn-shanghai-e",
    "BackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
    "Active": true,
    "CreatedTime": "2020-02-26T01:56Z",
    "ClusterId": "cds-uf6m0bo****v6159",
    "BackupTime": "00:30Z",
    "RetentionPeriod": 7
  }
}

Error codes

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