调用方式

更新时间：2017-06-07 13:26:11   分享：

对 API 网关 API 接口调用是通过向 API 网关 API 的服务端地址发送HTTP GET请求，并按照接口说明在请求中加入相应请求参数来完成的；根据请求的处理情况，系统会返回处理结果。

请求结构

服务地址

API网关 API的服务接入地址为：apigateway.[RegionId].aliyuncs.com.

如：apigateway.cn-hangzhou.aliyuncs.com

通信协议

支持通过HTTP或HTTPS通道进行请求通信。为了获得更高的安全性，推荐您使用HTTPS通道发送请求。

请求方法

支持HTTP GET方法发送请求，这种方式下请求参数需要包含在请求的URL中。

请求参数

每个请求都需要指定要执行的操作，即Action参数（例如CreateApi），以及每个操作都需要包含的公共请求参数和指定操作所特有的请求参数。

字符编码

请求及返回结果都使用UTF-8字符集进行编码。

公共参数

公共请求参数

公共请求参数是指每个接口都需要使用到的请求参数。

名称	类型	是否必填	描述
Format	String	否	返回值的类型，支持JSON与XML。默认为XML
Version	String	是	API版本号，为日期形式：YYYY-MM-DD，本版本对应为2016-07-14
AccessKeyId	String	是	阿里云颁发给用户的访问服务所用的密钥ID
Signature	String	是	签名结果串，关于签名的计算方法，请参见签名机制。
SignatureMethod	String	是	签名方式，目前支持HMAC-SHA1
TimeStamp	String	是	请求的时间戳。日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。例如，2014-11-11T12:00:00Z（为北京时间2014年11月11日20点0分0秒）
SignatureVersion	String	是	签名算法版本，目前版本是1.0
SignatureNonce	String	是	唯一随机数，用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值

请求示例：

1. https://apigateway.cn-hangzhou.aliyuncs.com/?Format=xml
2. &Version=2016-07-14
3. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
4. &SignatureMethod=HMACSHA1
5. &SignatureNonce=15215528852396
6. &SignatureVersion=1.0
7. &AccessKeyId=key-test
8. &TimeStamp=2016-08-08T08:00:00Z

公共返回参数

用户发送的每次接口调用请求，无论成功与否，系统都会返回一个唯一识别码RequestId给用户。

XML返回示例：

1. <?xml version="1.0" encoding="UTF-8"?>
2. <!—结果的根结点-->
3. <接口名称+Response>
4. <!—返回请求标签-->
5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
6. <!—返回结果数据-->
7. </接口名称+Response>

JSON返回示例：

1. {
2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
3. /* 返回结果数据 */
4. }

返回结果

调用API服务后返回数据采用统一格式，返回的HTTP状态码为2xx，代表调用成功。返回4xx或5xx的HTTP状态码代表调用失败。

调用成功返回的数据格式主要有XML和JSON两种，外部系统可以在请求时传入参数来制定返回的数据格式，默认为XML格式。

本文档中的返回示例为了便于用户查看，做了格式化处理，实际返回结果是没有进行换行、缩进等处理的。

成功结果

XML返回示例：

（XML返回结果包括请求是否成功信息和具体的业务数据）

1. <?xml version="1.0" encoding="UTF-8"?>
2. <!—结果的根结点-->
3. <接口名称+Response>
4. <!—返回请求标签-->
5. <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
6. <!—返回结果数据-->
7. </接口名称+Response>

JSON示例：

1. {
2. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
3. /* 返回结果数据 */
4. }

错误结果

调用接口出错后，将不会返回结果数据。调用方可根据附表<错误查询表>来定位错误原因。

当调用出错时，HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID：RequestId和一个您该次请求访问的站点ID：HostId。在调用方找不到错误原因时，可以联系阿里云客服，并提供该HostId和RequestId，以便我们尽快帮您解决问题。

XML示例：

1. <?xml version="1.0" encoding="UTF-8"?>
2. <Error>
3. <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
4. <HostId>apigateway.cn-hangzhou.aliyuncs.com</HostId>
5. <Code>InternalError</Code>
6. <Message>The request processing has failed due to some unknown error.</Message>
7. </Error>

JSON示例：

1. {
2. "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
3. "HostId": "apigateway.cn-hangzhou.aliyuncs.com",
4. "Code": "InternalError",
5. "Message": "The request processing has failed due to some unknown error."
6. }

五、签名机制

详细说明

API网关服务会对每个访问的请求进行身份验证，所以无论使用HTTP还是HTTPS协议提交请求，都需要在请求中包含签名（Signature）信息。

API网关通过使用Access Key ID和Access Key Secret进行对称加密的方法来验证请求者身份。Access Key ID和Access Key Secret由阿里云官方颁发给访问者（可以通过阿里云官方网站申请和管理），其中

Access Key ID用于标识访问者的身份

Access Key Secret是用于加密签名字符串和服务器端验证签名字符串的密钥，必须严格保密，只有阿里云和用户知道。

用户在访问时，按照下面的方法对请求进行签名处理：

a. 使用请求参数构造规范化的请求字符串（Canonicalized Query String）

• 按照参数名称的字典顺序对请求中所有的请求参数（包括文档中描述的“公共请求参数”和给定了的请求接口的自定义参数，但不能包括“公共请求参数”中提到Signature参数本身）进行排序。

注：当使用GET方法提交请求时，这些参数就是请求URI中的参数部分（即URI中“?”之后由“&”连接的部分）。

• 对每个请求参数的名称和值进行编码。名称和值要使用UTF-8字符集进行URL编码，URL编码的编码规则是：

1. 对于字符 A-Z、a-z、0-9以及字符“-”、“_”、“.”、“~”不编码;
2. 对于其他字符编码成“%XY”的格式，其中XY是字符对应ASCII码的16进制表示。比如英文的双引号（”）对应的编码就是%22
3. 对于扩展的UTF-8字符，编码成“%XY%ZA…”的格式；
4. 需要说明的是英文空格（ ）要被编码是%20，而不是加号（+）。

1. 注：一般支持URL编码的库（比如Java中的java.net.URLEncoder）都是按照“application/x-www-form-urlencoded”的MIME类型的规则进行编码的。
3. 实现时可以直接使用这类方式进行编码，把编码后的字符串中加号（+）替换成%20、星号（*）替换成%2A、%7E替换回波浪号（~），即可得到上述规则描述的编码字符串。

• 对编码后的参数名称和值使用英文等号（=）进行连接。
• 再把英文等号连接得到的字符串按参数名称的字典顺序依次使用&符号连接，即得到规范化请求字符串。

b. 使用上一步构造的规范化字符串按照下面的规则构造用于计算签名的字符串：

1. StringToSign=
2. HTTPMethod + “&” +
3. percentEncode(“/”) + ”&” +
4. percentEncode(CanonicalizedQueryString)

其中HTTPMethod是提交请求用的HTTP方法，比GET。

percentEncode(“/”)是按照1.b中描述的URL编码规则对字符“/”进行编码得到的值，即“%2F”。

percentEncode(CanonicalizedQueryString)是对第1步中构造的规范化请求字符串按1.b中描述的URL编码规则编码后得到的字符串。

c. 按照RFC2104的定义，使用上面的用于签名的字符串计算签名HMAC值。注意：计算签名时使用的Key就是用户持有的Access Key Secret并加上一个“&”字符(ASCII:38)，使用的哈希算法是SHA1。

d. 按照Base64编码规则把上面的HMAC值编码成字符串，即得到签名值（Signature）。

e. 将得到的签名值作为Signature参数添加到请求参数中，即完成对请求签名的过程。

注意：得到的签名值在作为最后的请求参数值提交给API网关服务器的时候，要和其他参数一样，按照RFC3986的规则进行URL编码）。

以DescribeRegions为例，签名前的请求URL为：

1. http://apigateway.cn-qingdao.aliyuncs.com?Format=json&AccessKeyId=testid&Action=DescribeRegions&SignatureMethod=Hmac-SHA1&SignatureNonce=d48e931b-90c9-49c7-ac86-a70dd3607c88&SignatureVersion=1.0&Version=2016-07-14&Timestamp=2016-09-27T09%3A08%3A30Z

那么StringToSign就是：

1. GET&%2F&AccessKeyId%3Dtestid%26Action%3DDescribeRegions%26Format%3Djson%26SignatureMethod%3DHmac-SHA1%26SignatureNonce%3Dd48e931b-90c9-49c7-ac86-a70dd3607c88%26SignatureVersion%3D1.0%26Timestamp%3D2016-09-27T09%253A08%253A30Z%26Version%3D2016-07-14

假如使用的Access Key Id是“testid”，Access Key Secret是“testsecret”，用于计算HMAC的Key就是“testsecret&”，则计算得到的签名值是：

1. DRdMb%2F1m7PeToGRBApTl3wThyOg%3D

签名后的请求URL为（注意增加了Signature参数）：

1. http://apigateway.cn-qingdao.aliyuncs.com?Signature=DRdMb%2F1m7PeToGRBApTl3wThyOg%3D&Format=json&AccessKeyId=testid&Action=DescribeRegions&SignatureMethod=Hmac-SHA1&SignatureNonce=d48e931b-90c9-49c7-ac86-a70dd3607c88&SignatureVersion=1.0&Version=2016-07-14&Timestamp=2016-09-27T09%3A08%3A30Z