Queries the status of a backup task.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBackupStatus

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

ClusterId String Yes ld-m5eznlga4k5bcxxxx

The ID of the ApsaraDB for HBase Performance-enhanced Edition cluster whose backup task status you want to query.

Response parameters

Parameter Type Example Description
BackupStatus String opened

The status of the backup task. Valid values:

  • closed: The backup task is disabled.
  • opened: The backup task is enabled.
  • opening: The backup task is being enabled.
BdsClusterId String bds-m5e54q06ceyhxxxx

The ID of the Lindorm Tunnel Service (LTS) instance used for backup.

ClusterId String ld-m5eznlga4k5bcxxxx

The ID of the ApsaraDB for HBase Performance-enhanced Edition cluster whose backup task status is queried.
RequestId String F7E71430-A825-470A-B40B-DF3F3AAC9BEE

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeBackupStatus
&ClusterId=bds-bp194i50****bn9w
&<Common request parameters>

Sample success responses

XML format

<RequestId>F7E71430-A825-470A-B40B-DF3F3AAC9BEE</RequestId>
<BdsClusterId>bds-m5e54q06ceyhxxxx</BdsClusterId>
<ClusterId>ld-m5eznlga4k5bcxxxx</ClusterId>
<BackupStatus>opened</BackupStatus>

JSON format

{
    "RequestId":"F7E71430-A825-470A-B40B-DF3F3AAC9BEE",
    "BdsClusterId":"bds-m5e54q06ceyhxxxx",
    "ClusterId":"ld-m5eznlga4k5bcxxxx",
    "BackupStatus":"opened"
}

Error codes

For a list of error codes, see Service error codes.