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

說明 私網連接API必須通過發送HTTPS請求調用。

請求結構

私網連接的API是RPC風格,您可以通過發送GET請求調用私網連接API。

其請求結構如下:

https://Endpoint/?Action=xx&Parameters
其中:
  • Endpoint:私網連接API的服務接入地址為privatelink.aliyuncs.com
  • Action:要執行的操作,例如使用CreateVpcEndpoint創建終端節點。
  • Version:要使用的API版本,私網連接的API版本是2020-04-15
  • Parameters:請求參數,每個參數之間用“&”分隔。

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

下面是一個調用CreateVpcEndpoint接口創建終端節點的示例:
說明 為了便于用戶查看,本文檔中的示例都做了格式化處理。
https://privatelink.cn-huhehaote.aliyuncs.com/?Action=CreateVpcEndpoint
&Format=xml
&Version=2020-04-15
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z
…

API授權

為了確保您的賬號安全,建議您使用子賬號的身份憑證調用API。如果您使用RAM賬號調用私網連接API,您需要為該RAM賬號創建、附加相應的授權策略。

私網連接中可授權的資源和接口列表,參見RAM鑒權

API簽名

私網連接服務會對每個API請求進行身份驗證,需要在請求中包含簽名(Signature)信息。

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

RPC API需按如下格式在請求中增加簽名(Signature):

https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=xxxx%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf

CreateVpcEndpoint為例,假設AccessKey ID是testid, AccessKey Secret是testsecret,則簽名前的請求URL如下:

https://privatelink.cn-huhehaote.aliyuncs.com/?Action=CreateVpcEndpoint
&Timestamp=2016-02-23T12:46:24Z
&Format=XML
&AccessKeyId=testid
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
&Version=2020-04-15
&SignatureVersion=1.0
完成以下步驟計算簽名:
  1. 使用請求參數創建待簽名字符串:
    GET&%2F&AccessKeyId%3Dtestid&Action%3DCreateVpcEndpoint&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion%3D1.0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2019-04-15
  2. 計算待簽名的HMAC的值。

    在AccessKey Secret后添加一個“&”作為計算HMAC值的key。本示例中的key為testsecret&

    CT9X0VtwR86fNWS********juE=
  3. 將簽名加到請求參數中:
    https://privatelink.cn-huhehaote.aliyuncs.com/?Action=CreateVpcEndpoint
    &Timestamp=2016-02-23T12:46:24Z
    &Format=XML
    &AccessKeyId=testid
    &SignatureMethod=HMAC-SHA1
    &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
    &Version=2020-04-15
    &SignatureVersion=1.0
    &Signature=xxxx%3D