调用DescribeBackup获取备份概要信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeBackup

系统规定参数。取值：DescribeBackup。
BackupId String 是 2020010121****

备份ID。
BackupType String 是 Incremental

备份类型。取值：

  • full：全量备份
  • Incremental：增量备份
ClusterId String 是 cds-bp11tjzh50****78

备份集群ID。
DataCenterId String 是 cn-hangzhou-g

备份集群数据中心ID。

返回数据

名称 类型 示例值 描述
Backup Struct

备份计划概要信息列表。
BackupId String 2020010121****

备份ID。
BackupType String Incremental

备份类型。取值：

  • full：全量备份
  • Incremental：增量备份
ClusterId String cds-bp11tjzh50****7v

备份集群ID。
DataCenterId String cn-hangzhou-g

备份集群数据中心ID。
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}

备份细节。
EndTime String 2020-01-01 21:48:54Z

备份结束时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 通用标准时，以Z来标识）。
Size Long 149016650

备份大小。
StartTime String 2020-01-01 21:48:40Z

备份开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 通用标准时，以Z来标识）。
Status String Succeeded

备份状态。可取值部分示例：

  • Succeeded：成功
  • Failed：失败
RequestId String 200FB963-9359-4CAD-90B7-96395C88FD9D

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackup
&BackupId=2020010121****
&BackupType=Incremental
&ClusterId=cds-bp11tjzh50****78
&DataCenterId= cn-hangzhou-g
&<公共请求参数>

正常返回示例

XML 格式 

<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 格式 

{
  "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"
  }
}

错误码

访问错误中心查看更多错误码。