智能接入網關接口調用是通過向智能接入網關API的服務端地址發送HTTP GET請求，請按照接口說明在請求中加入相應請求參數，調用后系統會返回處理結果。請求及返回結果都使用UTF-8字符集進行編碼。

請求結構

智能接入網關的API是RPC風格，您可以通過發送HTTP GET請求調用智能接入網關API。

其請求結構如下：
http://endpoint/?Action=xx&parameters

其中：

  • Endpoint：智能接入網關API的服務接入地址為 smartag.cn-shanghai.aliyuncs.com。
  • Action：要執行的操作，如使用DescribeSmartAccessGateways查詢已創建的智能接入網關實例。
  • Version：要使用的API版本，智能接入網關的API版本是2018-03-13。
  • Parameters：請求參數，每個參數之間用“&”分隔。

    請求參數由公共請求參數和API自定義參數組成。公共參數中包含API版本號、身份驗證等信息。

下面是一個調用DescribeSmartAccessGateways接口查詢已創建的智能接入網關實例的示例：

為了便于用戶查看，本文檔中的示例都做了格式化處理。



https://smartag.cn-shanghai.aliyuncs.com/?Action=DescribeSmartAccessGateways
&Format=xml
&Version=2018-03-13
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2018-04-01T12:00:00Z

API授權

為了確保您的賬號安全，建議您使用子賬號的身份憑證調用API。如果您使用RAM賬號調用智能接入網關API，您需要為該RAM賬號創建、附加相應的授權策略。詳情參見RAM鑒權。

API簽名

智能接入網關服務會對每個API請求進行身份驗證，無論使用HTTP還是HTTPS協議提交請求，都需要在請求中包含簽名（Signature）信息。

智能接入網關通過使用AccessKey ID和AccessKey Secret進行對稱加密的方法來驗證請求的發送者身份。AccessKey是為阿里云賬號和RAM用戶發布的一種身份憑證（類似于用戶的登錄密碼），其中AccessKey ID 用于標識訪問者的身份，AccessKey Secret是用于加密簽名字符串和服務器端驗證簽名字符串的密鑰，必須嚴格保密，只有阿里云和用戶知道。

用戶在訪問時，按照下面的方法對請求進行簽名處理：
  1. 使用請求參數構造規范化的請求字符串（Canonicalized Query String）。
    1. 按照參數名稱的字典順序對請求中所有的請求參數（包括文檔中描述的“公共請求參數”和給定了的請求接口的自定義參數，但不能包括“公共請求參數”中提到Signature參數本身）進行排序。
      注意 當使用GET方法提交請求時，這些參數就是請求URL中的參數部分（即URL中“?”之后由“&”連接的部分）。
    2. 對每個請求參數的名稱和值進行編碼。名稱和值要使用UTF-8字符集進行URL編碼，URL編碼的編碼規則是：
      1. 對于字符 A-Z、a-z、0-9以及字符（-）、（_）、（.）、（~）不編碼。
      2. 對于其他字符編碼成“%XY”的格式，其中XY是字符對應ASCII碼的16進制表示。比如英文的雙引號（”）對應的編碼就是%22。
      3. 對于擴展的UTF-8字符，編碼成“%XY%ZA…”的格式。
      4. 需要說明的是英文空格（ ）要被編碼是%20，而不是加號（+）。
        注意 一般支持URL編碼的庫（比如Java中的java.net.URLEncoder）都是按照“application/x-www-form-urlencoded”的MIME類型的規則進行編碼的。實現時可以直接使用這類方式進行編碼，把編碼后的字符串中加號（+）替換成%20、星號（*）替換成%2A、%7E替換回波浪號（~），即可得到上述規則描述的編碼字符串。
    3. 對編碼后的參數名稱和值使用英文等號（=）進行連接。
    4. 再把英文等號連接得到的字符串按參數名稱的字典順序依次使用&符號連接，即得到規范化請求字符串。
  2. 使用上一步構造的規范化字符串按照下面的規則構造用于計算簽名的字符串：
    StringToSign=
HTTPMethod + "&" +
percentEncode("/") + "&" +
percentEncode(CanonicalizedQueryString)
    參數說明：
    • HTTPMethod：提交請求用的HTTP方法，例如GET。
    • percentEncode(“/“)：按照1.ii中描述的URL編碼規則對字符“/”進行編碼得到的值，即“%2F”。
    • percentEncode(CanonicalizedQueryString)：對第1步中構造的規范化請求字符串按步驟1.ii中描述的URL編碼規則編碼后得到的字符串。
  3. 按照RFC2104的定義，使用上面的用于簽名的字符串計算簽名HMAC值。
    注意 計算簽名時使用的Key就是用戶持有的Access Key Secret并加上一個“&”字符（ASCII:38），使用的哈希算法是SHA1。
  4. 按照Base64編碼規則把上面的HMAC值編碼成字符串，即得到簽名值（Signature）。
  5. 將得到的簽名值作為Signature參數添加到請求參數中，即完成對請求簽名的過程。
    說明 得到的簽名值在作為最后的請求參數值提交給智能接入網關服務的時候，要和其他參數一樣，按照RFC3986的規則進行URL編碼。以DescribeSmartAccessGateways為例，簽名前的請求URL為：
    http://smartag.cn-shanghai.aliyuncs.com/?Timestamp=2016-04-23T12:46:24Z&Format=XML&AccessKeyId=testid&Action=DescribeSmartAccessGateways&SignatureMethod=HMAC-SHA1&RegionId=region1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&Version=2018-03-13&SignatureVersion=1.0
  6. 那么StringToSign就是：
    GET&%2F&AccessKeyId%3Dtestid&Action%DescribeSmartAccessGateways&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion%3D1.0&Timestamp%3D2018-04-23T12%253A46%253A24Z&Version%3D2018-03-13
  7. 假如使用的Access Key Id是“testid”，Access Key Secret是“testsecret”，用于計算HMAC的Key就是“testsecret&”，則計算得到的簽名值是：CT9X0VtwR86fNWSnsc6v8YGOjuE=
    簽名后的請求URL為（注意增加了Signature參數）：
    http://smartag.cn-shanghai.aliyuncs.com/?Timestamp=2016-04-23T12%3A46%3A24Z&Format=XML&AccessKeyId=testid&Action=DescribeSmartAccessGateways&SignatureMethod=HMAC-SHA1&RegionId=region1&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion=1.0&Version=2018-03-13&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D