You can call this operation to query the backup summary.

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 DescribeBackup

The operation that you want to perform. Set the value to DescribeBackup.
BackupId String Yes 2020010121****

The ID of the backup.
BackupType String Yes Incremental

The type of the backup. Valid values:

  • full: a full backup.
  • Incremental: an incremental backup.
ClusterId String Yes cds-bp11tjzh50****78

The ID of the cluster for the backup.
DataCenterId String Yes cn-hangzhou-g

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

Response parameters

Parameter Type Example Description
Backup Struct

The summary information of the backup plan.
BackupId String 2020010121****

The ID of the backup.
BackupType String Incremental

The type of the backup. Valid values:

  • full: a full backup.
  • Incremental: an incremental backup.
ClusterId String cds-bp11tjzh50****7v

The ID of the cluster for the backup.
DataCenterId String cn-hangzhou-g

The ID of the data center for the backup in the cluster.
Details String {"name": "cds-uf6m0bod****6159-20200226", "start": "2020-02-26 01:57:05", "end": "2020-02-26 02:12:50", "completeNodes": ["cds-uf6m0bod4****159-1-core-002.cassandra.rds.aliyuncs.com", "cds-uf6m0bo****v6159-1-core-001.cassandra.rds.aliyuncs.com", "cds-uf6m0bod****6159-1-core-003.cassandra.rds.aliyuncs.com"], "incompleteNodes": [], "missingNodes": [], "files": 923, "size": 149016650}

The details of the backup.
EndTime String 2020-01-01 21:48:54Z

The end time of the backup task. 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.

Size  Long 149016650

The size of the backup.
StartTime String 2020-01-01 21:48:40Z

The start time of the backup task. 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.

Status String Succeeded

The status of the backup. Valid values:

  • Succeeded: The backup was created.
  • Failed: The backup failed to create.
RequestId String 200FB963-9359-4CAD-90B7-96395C88FD9D

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeBackup
&BackupId=2020010121****
&BackupType=Incremental
&ClusterId=cds-bp11tjzh50****78
&DataCenterId= cn-hangzhou-g
&<Common request parameters>

Sample success responses

XML format 

<DescribeBackupResponse>
      <RequestId>FA04A743-6C3F-4C06-A2B7-6B75B9D3D18C</RequestId>
      <Backup>
            <Status>Succeeded</Status>
            <DataCenterId>cn-shanghai-e</DataCenterId>
            <Details>{"name": "cds-uf6m0bod****6159-20200226", "start": "2020-02-26 01:57:05", "end": "2020-02-26 02:12:50", "completeNodes": ["cds-uf6m0bod****6159-1-core-002.cassandra.rds.aliyuncs.com", "cds-uf6m0bod****6159-1-core-001.cassandra.rds.aliyuncs.com", "cds-uf6m0bod****6159-1-core-003.cassandra.rds.aliyuncs.com"], "incompleteNodes": [], "missingNodes": [], "files": 923, "size": 149016650}
    </Details>
            <EndTime>2020-02-26T02:12:50Z</EndTime>
            <ClusterId>cds-uf6m0bo****v6159</ClusterId>
            <Size>149016650</Size>
            <StartTime>2020-02-26T01:57:00Z</StartTime>
            <BackupId>20200226</BackupId>
            <BackupType>Incremental</BackupType>
      </Backup>
</DescribeBackupResponse>

JSON format 

{
  "RequestId": "FA04A743-6C3F-4C06-A2B7-6B75B9D3D18C",
  "Backup": {
    "Status": "Succeeded",
    "DataCenterId": "cn-shanghai-e",
    "Details": "{\"name\": \"cds-uf6m0bod****6159-20200226\", \"start\": \"2020-02-26 01:57:05\", \"end\": \"2020-02-26 02:12:50\", \"completeNodes\": [\"cds-uf6m0bod****6159-1-core-002.cassandra.rds.aliyuncs.com\", \"cds-uf6m0bod****6159-1-core-001.cassandra.rds.aliyuncs.com\", \"cds-uf6m0bod****6159-1-core-003.cassandra.rds.aliyuncs.com\"], \"incompleteNodes\": [], \"missingNodes\": [], \"files\": 923, \"size\": 149016650}\n",
    "EndTime": "2020-02-26T02:12:50Z",
    "ClusterId": "cds-uf6m0bo****v6159",
    "Size": 149016650,
    "StartTime": "2020-02-26T01:57:00Z",
    "BackupId": "20200226",
    "BackupType": "Incremental"
  }
}

Error codes

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