通过DescribeBackups获取HBase集群备份记录信息。

调试

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

请求参数

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

系统规定参数。取值：DescribeBackups。
ClusterId String 是 hb-t4naqsay5gn****

集群ID。
BackupId String 否 job-xxxx

要查询的备份ID。
PageNumber String 否 1

页码。
PageSize String 否 10

页面大小。
StartTime String 否 2020-12-13 00:00:00

查询备份的开始时间，格式为yyyy-MM-dd HH:mm。
EndTime String 否 2020-12-23 23:59:59

查询备份的结束时间，格式为yyyy-MM-dd HH:mm。
StartTimeUTC String 否 2020-12-12T16:00:00Z

查询备份的开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。
EndTimeUTC String 否 2020-12-23T15:59:59Z

查询备份的结束时间，必须晚于查询开始时间，格式为yyyy-MM-ddTHH:mmZ（UTC时间）。

返回数据

名称 类型 示例值 描述
Backups Array of Backup

备份记录集合。
Backup
BackupDBNames String 1

备份数据库名称。
BackupDownloadURL String 1

备份下载链接。
BackupEndTime String 2020-12-23 17:25:24

备份完成时间。
BackupEndTimeUTC String 2020-12-23T09:25:24Z

备份完成的UTC时间。
BackupId Integer 511876087

备份ID。
BackupMethod String P

备份方法。P为物理备份。
BackupMode String 0

备份策略。0为系统备份。
BackupSize String 0.00

备份数据大小。单位GB。
BackupStartTime String 2020-12-23 17:25:08

备份开始时间。
BackupStartTimeUTC String 2020-12-23T09:25:08Z

备份开始的UTC时间。
BackupStatus String 0

备份状态。

  • 0：备份已完成。
  • 1：备份中。
BackupType String F

备份类型。F为全量备份。
EnableStatus String enable

备份开启状态。

  • enable：已开启。
  • disable： 未开启。
  • opening：开启中。
PageNumber Integer 1

页码。
PageSize Integer 10

页面大小。
RequestId String A93CE373-0FDE-4CCB-9DBA-6700906825ED

请求ID。
TotalCount Integer 1

总记录数。

示例

请求示例

http(s)://hbase.aliyuncs.com/?Action=DescribeBackups
&ClusterId=hb-t4naqsay5gn******
&<公共请求参数>

正常返回示例

XML格式 

<TotalCount>1</TotalCount>
<RequestId>A93CE373-0FDE-4CCB-9DBA-6700906825ED</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<EnableStatus>enable</EnableStatus>
<Backups>
    <Backup>
        <BackupMethod>P</BackupMethod>
        <BackupDownloadURL/>
        <BackupEndTime>2020-12-23 17:25:24</BackupEndTime>
        <BackupMode>0</BackupMode>
        <BackupSize>0.00</BackupSize>
        <BackupStartTime>2020-12-23 17:25:08</BackupStartTime>
        <BackupEndTimeUTC>2020-12-23T09:25:24Z</BackupEndTimeUTC>
        <BackupId>511876087</BackupId>
        <BackupType>F</BackupType>
        <BackupStartTimeUTC>2020-12-23T09:25:08Z</BackupStartTimeUTC>
        <BackupDBNames/>
        <BackupStatus>0</BackupStatus>
    </Backup>
</Backups>

JSON格式 

{
  "TotalCount": 1,
  "RequestId": "A93CE373-0FDE-4CCB-9DBA-6700906825ED",
  "PageSize": 10,
  "PageNumber": 1,
  "EnableStatus": "enable",
  "Backups": {
    "Backup": [
      {
        "BackupMethod": "P",
        "BackupDownloadURL": "",
        "BackupEndTime": "2020-12-23 17:25:24",
        "BackupMode": 0,
        "BackupSize": "0.00",
        "BackupStartTime": "2020-12-23 17:25:08",
        "BackupEndTimeUTC": "2020-12-23T09:25:24Z",
        "BackupId": 511876087,
        "BackupType": "F",
        "BackupStartTimeUTC": "2020-12-23T09:25:08Z",
        "BackupDBNames": "",
        "BackupStatus": "0"
      }
    ]
  }
}

错误码

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