公共參數是指所有接口調用都需要用到的參數,包含公共請求參數和公共返回參數。
公共請求參數
名稱 | 類型 | 是否必須 | 描述 |
---|---|---|---|
Format | String | 否 | 返回值的類型為JSON格式或XML格式。 |
Version | String | 是 | API版本號,為日期形式:YYYY-MM-DD,本版本對應的版本號為2019-03-27。 |
AccessKeyId | String | 是 | 阿里云分配給用戶訪問服務所用的密鑰ID。 |
Signature | String | 是 | 簽名結果串。關于簽名的計算方法,請參見簽名機制。 |
Timestamp | String | 是 | 請求的時間戳。日期格式按照ISO8601標準表示,并需要使用UTC時間,格式為YYYY-MM-DDThh:mm:ssZ。例如,2013-08-15T12:00:00Z為北京時間2013年8月15日20點0分0秒。 |
SignatureVersion | String | 是 | 簽名算法版本,目前的版本是1.0。 |
SignatureNonce | String | 是 | 唯一隨機數,用于防止網絡重放攻擊。在不同請求間要使用不同的隨機數值。 |
公共返回參數
用戶發送的每次接口調用請求,無論成功與否,系統都會返回一個唯一識別碼RequestId給用戶。
請求示例
https://dg.aliyuncs.com/
?Format=xml
&Version=2019-03-27
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2014-10-10T12:00:00Z
返回示例
調用API服務后,系統返回的數據采用統一格式。返回2xx的HTTP狀態碼,表示調用成功;返回4xx或5xx的HTTP狀態碼,表示調用失敗。調用成功返回的數據格式是JSON格式,外部系統可以在請求時傳入參數來制定返回的數據格式。為了便于查看,本文檔中的返回示例做了格式化處理,實際返回結果是沒有進行換行、縮進等處理的。
XML格式
<?xml version="1.0" encoding="utf-8"?>
<!--結果的根結點-->
<接口名稱+Response>
<!--返回請求標簽-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!--返回結果數據-->
</接口名稱+Response>
JSON格式
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
/* 返回結果數據 */
}