彈性公網IP和專有網絡使用同一個服務地址(endpoint)。接口調用是向彈性公網IP API的服務端地址發送HTTP或HTTPS GET請求。您需要按照接口說明在請求中加入相應請求參數,調用后系統會返回處理結果。請求及返回結果都使用UTF-8字符集進行編碼。

請求結構

彈性公網IP的API是RPC風格,您可以通過發送HTTP或HTTPS GET請求調用彈性公網IP API。

其請求結構如下:
http(s)://Endpoint/?Action=xx&Parameters
其中:
  • Endpoint:彈性公網IP API的服務接入地址為vpc.aliyuncs.com
  • Action:要執行的操作,如使用AllocateEipAddress申請彈性公網IP。
  • Version:要使用的API版本,彈性公網IP的API版本是2016-04-28
  • Parameters:請求參數,每個參數之間用&分隔。

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

下面是調用AllocateEipAddress接口申請彈性公網IP的示例:
說明 為了便于查看,本文檔中的示例都做了格式化處理。
https://vpc.aliyuncs.com/?Action=AllocateEipAddress
&Format=xml
&Version=2016-04-28
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z
…

API授權

為了確保您的賬號安全,建議您使用RAM用戶的身份憑證調用API。如果您使用RAM用戶調用彈性公網IP API,您需要創建相應的授權策略,并將其附加給RAM用戶。

彈性公網IP中可授權的資源和接口列表,請參見RAM鑒權

API簽名

彈性公網IP服務會對每個API請求進行身份驗證,無論使用HTTP還是HTTPS協議提交請求,都需要在請求中包含簽名(Signature)信息。

彈性公網IP通過使用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-4e0axxxxxxxx
AllocateEipAddress為例,假設AccessKey ID是testid, AccessKey Secret是testsecret,則簽名前的請求URL如下:
http://vpc.aliyuncs.com/?Action=AllocateEipAddress
&Timestamp=2016-05-23T12:46:24Z
&Format=XML
&AccessKeyId=testid
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx
&Version=2016-04-28
&SignatureVersion=1.0
完成以下步驟計算簽名:
  1. 使用請求參數創建待簽名字符串:
    GET&%2F&AccessKeyId%3Dtestid&Action%3DAllocateEipAddress&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx&SignatureVersion%3D1.0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2016-04-28
  2. 計算待簽名的HMAC的值。
    在AccessKey Secret后添加一個&作為計算HMAC值的key。本示例中的key為testsecret&。計算得到的簽名值為:
    CT9X0VtwR86fNWS********juE=
  3. 將得到的簽名值作為Signature參數添加到請求參數中:
    說明 得到的簽名值在作為最后的請求參數值提交時要和其它參數一樣,按照RFC3986的規則進行URL編碼。
    http://vpc.aliyuncs.com/?Action=AllocateEipAddress
    &Timestamp=2016-05-23T12:46:24Z
    &Format=XML
    &AccessKeyId=testid
    &SignatureMethod=HMAC-SHA1
    &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0axxxxxxxx
    &Version=2016-04-28
    &SignatureVersion=1.0
    &Signature=CT9X0VtwR86fNWS********juE=