全部产品
Search
文档中心

:调用方式

更新时间:Sep 21, 2023

本文介绍云备份API的调用方式,适用基于API URL发起HTTP GET或HTTPS POST请求的用户。云备份接口调用是向云备份 API的服务端地址发送HTTP GET或HTTPS POST请求,并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。

请求结构

云备份API是RPC风格,您可以通过发送HTTP GET或HTTPS POST请求调用云备份API。

其请求结构如下:

http(s)://Endpoint/?Action=xx&Parameters

其中:

  • Endpoint:云备份API的服务接入地址。例如取值为hbr.cn-hangzhou.aliyuncs.com。

  • Action:要执行的操作,如调用CreateBackupPlan创建一个备份计划。

  • Parameters:请求参数,每个参数之间用and(&)分隔。

    请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息,由系统规定。更多信息,请参见公共参数

请求示例

下面是一个调用DescribeTask接口查询已创建的备份任务的示例:

说明

为了便于用户查看,本文档中的示例都做了格式化处理。本文中仅提供示例值,实际调用中请进行URL编码。

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
…