公共請求參數(shù)

每個 RPC 請求都需包含以下關(guān)鍵參數(shù)：

步驟一：構(gòu)造接口 URL

• 接口 URL 由以下部分組成：[協(xié)議][服務(wù)地址]?[公共參數(shù)][業(yè)務(wù)請求參數(shù)]。

• POST 方法應(yīng)將業(yè)務(wù)參數(shù)放于請求體中，GET 方法的參數(shù)則在 URL 查詢字符串中。

• 對請求參數(shù)進(jìn)行規(guī)范化編碼。例如： Timestamp 的參數(shù)值為 2016-02-23T12:46:24Z ，編碼后為 2016-02-23T12%3A46%3A24Z 。編碼方式請參見參數(shù)編碼方式。

接口 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

步驟二：發(fā)起接口調(diào)用

• GET 方法可使用瀏覽器、curl 或者 wget 等工具發(fā)起請求。

• POST方法需在請求體中傳入業(yè)務(wù)請求參數(shù)，并設(shè)置請求頭的Content-Type為application/x-www-form-urlencoded。

步驟一：構(gòu)造規(guī)范化請求字符串

1、參數(shù)排序：按照參數(shù)首字母的字典順序?qū)?shù)排序，排序參數(shù)包括公共請求參數(shù)和接口自定義參數(shù)（即 OpenAPI 文檔中的請求參數(shù)），不包括公共請求參數(shù)中的Signature參數(shù)。 公共請求參數(shù)詳情，請參見上文公共請求參數(shù)。偽代碼如下：

// 例：參數(shù)名集合 {b, a, C} 排序后為 {C, a, b}
sortParams = sorted(params.keys()）

2、編碼參數(shù)：使用 UTF-8 字符集按照RFC3986規(guī)則編碼請求參數(shù)和參數(shù)取值，編碼具體規(guī)則請參看參數(shù)編碼方式。為方便表述，我們將此步驟的編碼方法，命名為 encodeURIComponent。偽代碼如下：

// 例：請求參數(shù)為測試，參數(shù)取值為中文 編碼后分別是%E6%B5%8B%E8%AF%95和%E4%B8%AD%E6%96%87
encodeURIComponent(sortParams.keys, sortParams.values)

3、連接參數(shù)：使用等號（=）連接第二步得到的編碼后請求參數(shù)和參數(shù)值。然后用&連接所有參數(shù)。注意參數(shù)排序與第1步一致。偽代碼如下：

// 例：編碼后請求參數(shù)為test，參數(shù)取值為testvalue，則拼接為test=testvalue
encodeURIComponentParam.key=encodeURIComponentParam.value

得到了規(guī)范化請求字符串CanonicalizedQueryString。

步驟二：構(gòu)造簽名字符串

1、構(gòu)造待簽名字符串 stringToSign。該字符串構(gòu)造規(guī)則的偽代碼如下：

String stringToSign =
  HTTPMethod + "&" + // HTTPMethod：發(fā)送請求的 HTTP 方法，例如 GET。
  encodeURIComponent("/") + "&" + // encodeURIComponent 為步驟一第2步的編碼方法
  encodeURIComponent(CanonicalizedQueryString) // CanonicalizedQueryString 為步驟一獲取的規(guī)范化請求字符串。

本示例以調(diào)用 ECS DescribeDedicatedHosts查詢一臺或多臺專有宿主機的詳細(xì)信息為例。假設(shè) AccessKeyID 為 testid， AccessKeySecret 為 testsecret，SignatureNonce 為 edb2b34af0af9a6d14deaf7c1a5315eb， Timestamp 為 2023-03-13T08:34:30Z，簽名流程如下：

1. 構(gòu)造規(guī)范化請求字符串。

   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. 構(gòu)造待簽名字符串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規(guī)則編碼后的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

參數(shù)編碼方式

在阿里云 OpenAPI 調(diào)用中，請求參數(shù)和參數(shù)值需使用 UTF-8 字符集按照RFC3986規(guī)則進(jìn)行編碼。具體編碼規(guī)則如下：

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

• 對其他 ASCII 碼字符進(jìn)行編碼。編碼格式為%加上16進(jìn)制的 ASCII 碼。例如半角雙引號（"）將被編碼為 %22。

• 非 ASCII 碼通過 UTF-8 編碼。

• 空格編碼成%20，不使用加號（+）表示空格。