V2版本RPC风格请求体&签名机制

公共请求参数

每个 RPC 请求都需包含以下关键参数：

步骤一：构造接口 URL

• 接口 URL 由以下部分组成：[协议][服务地址]?[公共参数][业务请求参数]。

• POST 方法应将业务参数放于请求体中，GET 方法的参数则在 URL 查询字符串中。

• 对请求参数进行规范化编码。例如： Timestamp 的参数值为 2016-02-23T12:46:24Z ，编码后为 2016-02-23T12%3A46%3A24Z 。编码方式请参见参数编码方式。

接口 URL 示例：

http://ecs.aliyuncs.com/?SignatureVersion=1.0&Action=DescribeDedicatedHosts&Format=XML&SignatureNonce=3ee8c1b8-xxxx-xxxx-xxxx-xxxxxxxxx&Version=2014-05-26&AccessKeyId=testid&Signature=OLeaidS1JvxuMvnyHOwuJ%2BuX5qY%3D&SignatureMethod=HMAC-SHA1&Timestamp=2016-02-23T12%3A46%3A24Z&RegionId=cn-hangzhou&Status=Available

步骤二：发起接口调用

• GET 方法可使用浏览器、curl 或者 wget 等工具发起请求。

• POST方法需在请求体中传入业务请求参数，并设置请求头的Content-Type为application/x-www-form-urlencoded。

步骤一：构造规范化请求字符串

1、参数排序：按照参数首字母的字典顺序对参数排序，排序参数包括公共请求参数和接口自定义参数（即 OpenAPI 文档中的请求参数），不包括公共请求参数中的Signature参数。 公共请求参数详情，请参见上文公共请求参数。伪代码如下：

// 例：参数名集合 {b, a, C} 排序后为 {C, a, b}
sortParams = sorted(params.keys()）

2、编码参数：使用 UTF-8 字符集按照RFC3986规则编码请求参数和参数取值，编码具体规则请参看参数编码方式。为方便表述，我们将此步骤的编码方法，命名为 encodeURIComponent。伪代码如下：

// 例：请求参数为测试，参数取值为中文 编码后分别是%E6%B5%8B%E8%AF%95和%E4%B8%AD%E6%96%87
encodeURIComponent(sortParams.keys, sortParams.values)

3、连接参数：使用等号（=）连接第二步得到的编码后请求参数和参数值。然后用&连接所有参数。注意参数排序与第1步一致。伪代码如下：

// 例：编码后请求参数为test，参数取值为testvalue，则拼接为test=testvalue
encodeURIComponentParam.key=encodeURIComponentParam.value

得到了规范化请求字符串CanonicalizedQueryString。

步骤二：构造签名字符串

1、构造待签名字符串 stringToSign。该字符串构造规则的伪代码如下：

String stringToSign =
  HTTPMethod + "&" + // HTTPMethod：发送请求的 HTTP 方法，例如 GET。
  encodeURIComponent("/") + "&" + // encodeURIComponent 为步骤一第2步的编码方法
  encodeURIComponent(CanonicalizedQueryString) // CanonicalizedQueryString 为步骤一获取的规范化请求字符串。

本示例以调用 ECS DescribeDedicatedHosts查询一台或多台专有宿主机的详细信息为例。假设 AccessKeyID 为 testid， AccessKeySecret 为 testsecret，SignatureNonce 为 edb2b34af0af9a6d14deaf7c1a5315eb， Timestamp 为 2023-03-13T08:34:30Z，签名流程如下：

1. 构造规范化请求字符串。

   http://ecs.aliyuncs.com/?AccessKeyId=testid&Action=DescribeDedicatedHosts&Format=JSON&RegionId=cn-beijing&SignatureMethod=HMAC-SHA1&SignatureNonce=edb2b34af0af9a6d14deaf7c1a5315eb&SignatureVersion=1.0&Tag.1.Key=testkey&Tag.1.Value=testvalue&Timestamp=2023-03-13T08%3A34%3A30Z&Version=2014-05-26

2. 构造待签名字符串stringToSign。

   GET&%2F&AccessKeyId%3Dtestid%26Action%3DDescribeDedicatedHosts%26Format%3DJSON%26RegionId%3Dcn-beijing%26SignatureMethod%3DHMAC-SHA1%26SignatureNonce%3Dedb2b34af0af9a6d14deaf7c1a5315eb%26SignatureVersion%3D1.0%26Tag.1.Key%3Dtestkey%26Tag.1.Value%3Dtestvalue%26Timestamp%3D2023-03-13T08%253A34%253A30Z%26Version%3D2014-05-26

3. 计算签名值。例如 AccessKeySecret=testsecret，用于计算的 Key 为testsecret&（注意：加上后缀&）。计算得到的签名值为fRmq1o6saIIjVlawOy+o6jDU9JQ=。伪代码如下：

   String Signature = Base64(HMAC_SHA1(AccessSecret + "&",UTF_8_Encoding_Of(stringToSign)))

4. 得到完整的URL。添加RFC3986规则编码后的Signature=fRmq1o6saIIjVlawOy%2Bo6jDU9JQ%3D到第1步的 URL 中。

   https://ecs.cn-beijing.aliyuncs.com/?AccessKeyId=testid&Action=DescribeDedicatedHosts&Format=JSON&RegionId=cn-beijing&SignatureMethod=HMAC-SHA1&SignatureNonce=edb2b34af0af9a6d14deaf7c1a5315eb&SignatureVersion=1.0&Tag.1.Key=testkey&Tag.1.Value=testvalue&Timestamp=2023-03-13T08%3A34%3A30Z&Version=2014-05-26&Signature=fRmq1o6saIIjVlawOy%2Bo6jDU9JQ%3D

参数编码方式

在阿里云 OpenAPI 调用中，请求参数和参数值需使用 UTF-8 字符集按照RFC3986规则进行编码。具体编码规则如下：

• 字符 A~Z、a~z、0~9 以及字符-、_、.、~不编码。

• 对其他 ASCII 码字符进行编码。编码格式为%加上16进制的 ASCII 码。例如半角双引号（"）将被编码为 %22。

• 非 ASCII 码通过 UTF-8 编码。

• 空格编码成%20，不使用加号（+）表示空格。