本文檔列舉了云企業網API的公共請求參數和公共返回參數。
公共請求參數
公共請求參數是每個接口都需要使用到的請求參數。
名稱 | 類型 | 是否必須 | 描述 |
---|---|---|---|
Format | String | 否 | 返回消息的格式。取值:
JSON(默認值)| XML |
Version | String | 是 | API版本號,使用YYYY-MM-DD 日期格式。取值:
2017-09-12 |
AccessKeyId | String | 是 | 訪問服務使用的密鑰ID。 |
Signature | String | 是 | 簽名結果串。 |
SignatureMethod | String | 是 | 簽名方式,取值:
HMAC-SHA1 |
Timestamp | String | 是 | 請求的時間戳,為日期格式。使用UTC時間按照 ISO8601標,格式為YYYY-MM-DDThh:mm:ssZ 。
例如,北京時間2013年1月10日20點0分0秒,表示為2013-01-10T12:00:00Z。 |
SignatureVersion | String | 是 | 簽名算法版本,取值:
1.0 |
SignatureNonce | String | 是 | 唯一隨機數,用于防止網絡重放攻擊。
在不同請求間要使用不同的隨機數值。 |
示例
https://cbn.aliyuncs.com/?Action=DescribeCens
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&Action=DescribeCens
&SignatureMethod=Hmac-SHA1
&CenId=cen-test
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2016-04-28
&SignatureVersion=1.0
&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%xx
公共返回參數
API返回結果采用統一格式,返回2xx HTTP狀態碼代表調用成功;返回4xx或5xx HTTP狀態碼代表調用失敗。調用成功返回的數據格式有XML和JSON兩種,可以在發送請求時指定返回的數據格式,默認為JSON格式。
每次接口調用,無論成功與否,系統都會返回一個唯一識別碼RequestId。