全球加速接口调用是向全球加速API的服务端地址发送HTTP GET请求,并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。
请求结构
全球加速的API是RPC风格,您可以通过发送HTTP GET请求调用全球加速API。
http://Endpoint/?Action=xx&Parameters
- Endpoint:全球加速API的通用服务接入地址为ga.cn-hangzhou.aliyuncs.com。
- Action:要执行的操作,如使用DescribeAccelerator查询已创建的全球加速实例。
- Version:要使用的API版本,全球加速的API版本是2019-11-20。
- Parameters:请求参数,每个参数之间用“&”分隔。
请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息,详情参见公共参数。
https://ga.cn-hangzhou.aliyuncs.com/?Action=DescribeAccelerator
&Format=xml
&Version=2019-11-20
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2012-06-01T12:00:00Z
…
API签名
全球加速服务会对每个API请求进行身份验证,无论使用HTTP还是HTTPS协议提交请求,都需要在请求中包含签名(Signature)信息。
RPC API要按以下格式在API请求的Query中增加签名(Signature)。
https://Endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=xxxx%xxxx%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
- SignatureMethod:签名方式,目前支持HMAC-SHA1。
- SignatureVersion:签名算法版本,目前版本是 1.0。
- SignatureNonce:唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值,建议使用通用唯一识别码(Universally Unique Identifier, UUID)。
- Signature: 使用AccessKey Secret对请求进行对称加密后生成的签名。
全球加速通过使用AccessKey ID和AccessKey Secret进行对称加密的方法来验证请求的发送者身份。AccessKey是为阿里云账号和RAM用户发布的一种身份凭证(类似于用户的登录密码),其中AccessKey ID 用于标识访问者的身份,AccessKey Secret是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密。
https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=xxxx%xxxx%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
testid
, AccessKey Secret是testsecret
,则签名前的请求URL如下: http://ga.cn-hangzhou.aliyuncs.com/?Action=DescribeAccelerator
&TimeStamp=2016-02-23T12:46:24Z
&Format=XML
&AccessKeyId=testid
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
&Version=2019-11-20
&SignatureVersion=1.0
- 使用请求参数创建待签名字符串:
GET&%2F&AccessKeyId%3Dtestid%26Action%3DDescribeAccelerator%26Format%3DXML%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf%26SignatureVersion%3D1.0%26TimeStamp%3D2016-02-23T12%253A46%253A24Z%26Version%3D2014-05-26
- 按照参数名称的字典顺序对请求中所有的请求参数(包括公共请求参数和接口的自定义参数,但不包括公共请求参数中的Signature参数)进行排序。
当使用GET方法提交请求时,这些参数就是请求URI中的参数部分,即URI中问号(?)之后由&连接的部分。
- 对排序之后的请求参数的名称和值分别用UTF-8字符集进行URL编码。编码规则如下:
字符 编码方式 A-Z、a-z和0-9以及“-”、“_”、“.”和“~” 不编码。 其它字符 编码成 %XY
的格式,其中XY
是字符对应ASCII码的16进制表示。例如英文的双引号(””)对应的编码为%22
。扩展的UTF-8字符 编码成 %XY%ZA…
的格式。英文空格 编码成 %20
,而不是加号(+)。该编码方式和一般采用的
application/x-www-form-urlencoded
MIME格式编码算法(例如Java标准库中的java.net.URLEncoder
的实现)存在区别。编码时可以先用标准库的方式进行编码,然后把编码后的字符串中的加号(+)替换成
%20
,星号(*)替换成%2A
,%7E
替换回波浪号(~),即可得到上述规则描述的编码字符串。本算法可以用下面的percentEncode
方法来实现:private static final String ENCODING = "UTF-8"; private static String percentEncode(String value) throws UnsupportedEncodingException { return value != null ? URLEncoder.encode(value, ENCODING).replace("+", "%20").replace("*", "%2A").replace("%7E", "~") : null; }
- 将编码后的参数名称和值用英文等号(=)进行连接。
- 将等号连接得到的参数组合按步骤 i 排好的顺序依次使用“&”符号连接,即得到规范化请求字符串。
- 按照参数名称的字典顺序对请求中所有的请求参数(包括公共请求参数和接口的自定义参数,但不包括公共请求参数中的Signature参数)进行排序。
- 计算待签名的HMAC的值。
在AccessKey Secret后添加一个“&”作为计算HMAC值的key。本示例中的key为
testsecret&
。CT9X0VtwR86fNWSnsc6v8YGOjuE=
- 将签名加到请求参数中:
http://ga.cn-hangzhou.aliyuncs.com/?Action=DescribeAccelerator &TimeStamp=2016-02-23T12:46:24Z &Format=XML &AccessKeyId=testid &SignatureMethod=HMAC-SHA1 &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf &Version=2019-11-20 &SignatureVersion=1.0 &Signature=CT9X0VtwR86fNWSnsc6v****juE%3D