HBaseue备份开启后,通过DescribeBackupSummary接口获取备份详情。

请确保在使用该接口前,确认HBaseue集群已开通备份恢复功能。

调试

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

请求参数

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

系统规定参数。取值:DescribeBackupSummary。

ClusterId String ld-xxxxxxxxxxxxx

备份恢复的HBaseue集群Id。

PageNumber Integer 1

页码。可不传,默认1。

PageSize Integer 10

页码大小。可不传,默认10。

返回数据

名称 类型 示例值 描述
Full Struct

全量备份详情。

HasMore String false

是否有下一页,true/false。

NextFullBackupDate String 2020-11-09T18:00:00Z

下次全量备份时间。

PageNumber Integer 1

页码。

PageSize Integer 10

页面大小。

Records Array of Record

历史全量备份列表。

Record
CreateTime String 2020-11-02T18:00:00Z

全量备份开始时间。

DataSize String 1.2 kB

备份数据⼤⼩。

FinishTime String 2020-11-02T18:02:04Z

全量备份完成时间。

Process String 1/1

完成进度。

RecordId String 20201103020000

备份记录ID。

Speed String 0.00 MB/s

备份速度。

Status String SUCCESS

备份状态。

Total Integer 2

列表总数。

Incr Struct

增量备份详情。

BackupLogSize String 266 B

数据量。

Pos String 2020-11-05T01:20:31Z

同步点位。

QueueLogNum String 0

排队中LOG数量。

RunningLogNum String 2

备份中LOG数量。

Speed String 0.00 MB/s

当前增量备份写入速度。

Status String RUNNING

增量备份状态。

RequestId String 168793CB-7B31-43E7-ADAB-FE3E8D584D6E

请求Id。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackupSummary
&ClusterId=ld-xxxxxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>168793CB-7B31-43E7-ADAB-FE3E8D584D6E</RequestId>
<Incr>
    <Status>RUNNING</Status>
    <Speed>0.00 MB/s</Speed>
    <Pos>2020-11-05T01:20:31Z</Pos>
    <BackupLogSize>266 B</BackupLogSize>
    <QueueLogNum>0</QueueLogNum>
    <RunningLogNum>2</RunningLogNum>
</Incr>
<Full>
    <HasMore>false</HasMore>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <NextFullBackupDate>2020-11-09T18:00:00Z</NextFullBackupDate>
    <Total>2</Total>
    <Records>
        <Record>
            <Status>SUCCESS</Status>
            <Speed>0.00 MB/s</Speed>
            <FinishTime>2020-11-02T18:02:04Z</FinishTime>
            <CreateTime>2020-11-02T18:00:00Z</CreateTime>
            <DataSize>1.2 kB</DataSize>
            <Process>1/1</Process>
            <RecordId>20201103020000</RecordId>
        </Record>
        <Record>
            <Status>SUCCESS</Status>
            <Speed>0.00 MB/s</Speed>
            <FinishTime>2020-10-26T18:02:03Z</FinishTime>
            <CreateTime>2020-10-26T18:00:00Z</CreateTime>
            <DataSize>1.2 kB</DataSize>
            <Process>1/1</Process>
            <RecordId>20201027020000</RecordId>
        </Record>
    </Records>
</Full>

JSON 格式

{
    "RequestId":"168793CB-7B31-43E7-ADAB-FE3E8D584D6E",
    "Incr":{
        "Status":"RUNNING",
        "Speed":"0.00 MB/s",
        "Pos":"2020-11-05T01:20:31Z",
        "BackupLogSize":"266 B",
        "QueueLogNum":"0",
        "RunningLogNum":"2"
    },
    "Full":{
        "HasMore":false,
        "PageSize":10,
        "PageNumber":1,
        "NextFullBackupDate":"2020-11-09T18:00:00Z",
        "Total":2,
        "Records":{
            "Record":[
                {
                    "Status":"SUCCESS",
                    "Speed":"0.00 MB/s",
                    "FinishTime":"2020-11-02T18:02:04Z",
                    "CreateTime":"2020-11-02T18:00:00Z",
                    "DataSize":"1.2 kB",
                    "Process":"1/1",
                    "RecordId":"20201103020000"
                },
                {
                    "Status":"SUCCESS",
                    "Speed":"0.00 MB/s",
                    "FinishTime":"2020-10-26T18:02:03Z",
                    "CreateTime":"2020-10-26T18:00:00Z",
                    "DataSize":"1.2 kB",
                    "Process":"1/1",
                    "RecordId":"20201027020000"
                }
            ]
        }
    }
}

错误码

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