調用云企業網API接口是向云企業網API的服務端地址發送HTTP GET請求。您需要按照接口說明在請求中添加相應請求參數,調用后系統會返回處理結果。請求及返回結果都使用UTF-8字符集進行編碼。
請求結構
云企業網的API是RPC風格,您可以通過發送HTTP請求調用云企業網API。
其請求結構如下:
http://Endpoint/?Action=xx&Parameters
- Endpoint:是調用的云服務的接入點,云企業網的接入點是
cbn.aliyuncs.com
。 - Action:要執行的操作,例如使用DescribeCens查詢已創建的云企業網實例信息。
- Version:要使用的API版本,云企業網的API版本是2017-09-12。
- Parameters:請求參數,每個參數之間用and(&)符號分隔。
請求參數由公共請求參數和API自定義參數組成。公共參數中包含API版本號、身份驗證等信息。
https://cbn.aliyuncs.com/?Action=DescribeCens
&Format=xml
&Version=2017-09-12
&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用戶(子賬號)調用云企業網API,您需要為該RAM用戶(子賬號)創建、附加相應的授權策略。
云企業網中可進行授權的資源列表,參見RAM鑒權。
API簽名
云企業網服務會對每個API請求進行身份驗證,無論使用HTTP還是HTTPS協議提交請求,都需要在請求中包含簽名(Signature)信息。
云企業網通過使用AccessKey ID和AccessKey Secret進行對稱加密的方法來驗證請求的發送者身份。AccessKey是為阿里云賬號(主賬號)和RAM用戶(子賬號)發布的一種身份憑證(類似于用戶的登錄密碼),其中AccessKey ID用于標識訪問者的身份,AccessKey Secret是用于加密簽名字符串和服務器端驗證簽名字符串的密鑰,必須嚴格保密。
RPC API需按如下格式在請求中增加簽名(Signature):
https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
以DescribeCens為例,假設AccessKey ID是testid
, AccessKey Secret是testsecret
,則簽名前的請求URL如下:
http://cbn.aliyuncs.com/?Action=DescribeCens
&Timestamp=2016-02-23T12:46:24Z
&Format=XML
&AccessKeyId=testid
&SignatureMethod=HMAC-SHA1
&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf
&Version=2014-05-26&SignatureVersion=1.0
- 使用請求參數創建待簽名字符串:
GET&%2F&AccessKeyId%3Dtestid&Action%3DDescribeCens&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf&SignatureVersion%3D1.0&TimeStamp%3D2016-02-23T12%253A46%253A24Z&Version%3D2014-05-15
- 計算待簽名的HMAC的值。
在AccessKey Secret后添加一個and(&)符號作為計算HMAC值的key。本示例中的key為
testsecret&
。CT9X0VtwR86fNWSnsc6v****juE=
- 將簽名加到請求參數中:
http:/cbn.aliyuncs.com/?Action=DescribeCens &Timestamp=2016-02-23T12:46:24Z &Format=XML &AccessKeyId=testid &SignatureMethod=HMAC-SHA1 &SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf &Version=2014-05-26 &SignatureVersion=1.0 &Signature=CT9X0VtwR86fNWSnsc6v****juE%3D