調(diào)用云企業(yè)網(wǎng)API接口是向云企業(yè)網(wǎng)API的服務(wù)端地址發(fā)送HTTP GET請(qǐng)求。您需要按照接口說(shuō)明在請(qǐng)求中添加相應(yīng)請(qǐng)求參數(shù)，調(diào)用后系統(tǒng)會(huì)返回處理結(jié)果。請(qǐng)求及返回結(jié)果都使用UTF-8字符集進(jìn)行編碼。

請(qǐng)求結(jié)構(gòu)

云企業(yè)網(wǎng)的API是RPC風(fēng)格，您可以通過(guò)發(fā)送HTTP請(qǐng)求調(diào)用云企業(yè)網(wǎng)API。

其請(qǐng)求結(jié)構(gòu)如下：

http://Endpoint/?Action=xx&Parameters
其中：
  • Endpoint：是調(diào)用的云服務(wù)的接入點(diǎn)，云企業(yè)網(wǎng)的接入點(diǎn)是cbn.aliyuncs.com。
  • Action：要執(zhí)行的操作，例如使用DescribeCens查詢已創(chuàng)建的云企業(yè)網(wǎng)實(shí)例信息。
  • Version：要使用的API版本，云企業(yè)網(wǎng)的API版本是2017-09-12。
  • Parameters：請(qǐng)求參數(shù)，每個(gè)參數(shù)之間用and（&）符號(hào)分隔。

    請(qǐng)求參數(shù)由公共請(qǐng)求參數(shù)和API自定義參數(shù)組成。公共參數(shù)中包含API版本號(hào)、身份驗(yàn)證等信息。

下面是一個(gè)調(diào)用DescribeCens接口查詢已創(chuàng)建的云企業(yè)網(wǎng)實(shí)例的示例：
說(shuō)明 為了便于用戶查看，本文檔中的示例都做了格式化處理。 
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授權(quán)

為了確保您的賬號(hào)安全，建議您使用RAM用戶（子賬號(hào)）的身份憑證調(diào)用API。如果您使用RAM用戶（子賬號(hào)）調(diào)用云企業(yè)網(wǎng)API，您需要為該RAM用戶（子賬號(hào)）創(chuàng)建、附加相應(yīng)的授權(quán)策略。

云企業(yè)網(wǎng)中可進(jìn)行授權(quán)的資源列表，參見(jiàn)RAM鑒權(quán)。

API簽名

云企業(yè)網(wǎng)服務(wù)會(huì)對(duì)每個(gè)API請(qǐng)求進(jìn)行身份驗(yàn)證，無(wú)論使用HTTP還是HTTPS協(xié)議提交請(qǐng)求，都需要在請(qǐng)求中包含簽名（Signature）信息。

云企業(yè)網(wǎng)通過(guò)使用AccessKey ID和AccessKey Secret進(jìn)行對(duì)稱加密的方法來(lái)驗(yàn)證請(qǐng)求的發(fā)送者身份。AccessKey是為阿里云賬號(hào)（主賬號(hào)）和RAM用戶（子賬號(hào)）發(fā)布的一種身份憑證（類似于用戶的登錄密碼），其中AccessKey ID用于標(biāo)識(shí)訪問(wèn)者的身份，AccessKey Secret是用于加密簽名字符串和服務(wù)器端驗(yàn)證簽名字符串的密鑰，必須嚴(yán)格保密。

RPC API需按如下格式在請(qǐng)求中增加簽名（Signature）：

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

以DescribeCens為例，假設(shè)AccessKey ID是testid， AccessKey Secret是testsecret，則簽名前的請(qǐng)求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
完成以下步驟計(jì)算簽名：
  1. 使用請(qǐng)求參數(shù)創(chuàng)建待簽名字符串：
    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
  2. 計(jì)算待簽名的HMAC的值。

    在AccessKey Secret后添加一個(gè)and（&）符號(hào)作為計(jì)算HMAC值的key。本示例中的key為testsecret&。 

    CT9X0VtwR86fNWSnsc6v****juE=
  3. 將簽名加到請(qǐng)求參數(shù)中： 
    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