This topic describes how to call a Hybrid Backup Recovery (HBR) API operation. If you send an HTTP GET or HTTPS POST request based on a request URL, you can use the invocation methods that are described in this topic. To send an HBR API request, you must send an HTTP GET request or HTTPS POST request to an HBR endpoint. You must also add the required request parameters to the request. After you call the API operation, the system returns a response. Requests and responses are encoded in UTF-8.

Request structure

HBR API operations use the RPC protocol. You can call HBR API operations by sending HTTP GET or HTTPS POST requests.

A request uses the following syntax:
http(s)://Endpoint/?Action=xx&Parameters
where:
  • Endpoint: an HBR endpoint. Example: hbr.cn-hangzhou.aliyuncs.com.
  • Action: the operation that you want to perform. For example, you can call the CreateBackupPlan operation to create a backup plan.
  • Parameters: the request parameters for the operation. Separate multiple parameters with ampersands (&).

    Request parameters include common request parameters and operation-specific request parameters. Common request parameters include an API version number and authentication information. For more information, see Common parameters.

Sample requests

The following example shows how to call the DescribeTask operation to query the backup jobs that you created.
Note The sample requests are formatted to improve readability. The values in the following example are for reference only. In actual scenarios, you must perform URL encoding on the requests.
https://hbr.cn-hangzhou.aliyuncs.com/?Action=DescribeTask
&Format=xml
&Version=2017-09-08
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2021-09-01T12:00:00Z
...