全部產品
Search
文件中心

:公用參數

更新時間:Aug 09, 2024

公用請求參數

公用請求參數是指調用每個介面都需要使用到的請求參數。

名稱

類型

是否必須

描述

Format

String

傳回值的類型,支援 JSON 與 XML。預設為 XML。

Version

String

API 版本號碼,為日期形式:YYYY-MM-DD。如果參數 RegionID 是 cn-hangzhou,則版本對應為2015-11-23;如參數 RegionID 是cn-hangzhou 以外其他 Region,比如 ap-southeast-1,則版本對應為2017-06-22

AccessKeyId

String

阿里雲頒發給使用者的訪問服務所用的金鑰識別碼,可以通過控制台AccessKey管理來建立。

Signature

String

簽名結果串,關於簽名的計算方法,請參見簽名機制

SignatureMethod

String

簽名方式,目前支援 HMAC-SHA1。

Timestamp

String

請求的時間戳記。日期格式按照 ISO8601 標準表示,並需要使用 UTC 時間。格式為YYYY-MM-DDThh:mm:ssZ。 例如,2015-11-23T04:00:00Z(為北京時間 2015 年 11 月 23 日 12 點 0 分 0 秒)。

SignatureVersion

String

簽名演算法版本,目前版本是 1.0。

SignatureNonce

String

唯一隨機數,用於防止網路重放攻擊。不同的請求要使用不同的隨機數值。您可以使用UUID(隨機串),也可以自訂。

RegionId

String

機房資訊。具體值請參考文檔中的RegionId欄位:API服務地址

樣本

https://dm.aliyuncs.com/
?Format=xml
&Version=2015-11-23
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D 
&SignatureMethod=HMAC-SHA1
&SignatureNonce=e1b44502-6d13-4433-9493-69eeb068e955
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2015-11-23T12:00:00Z

公用返回參數

使用者發送的每次介面調用請求,無論成功與否,系統都會返回一個唯一識別碼 RequestId。

參數

類型

描述

RequestId

String

阿里雲為該請求產生的唯一識別碼。

樣本

XML樣本

<?xml version="1.0" encoding="UTF-8"?> 
<!-結果的根結點-->
<介面名稱+Response>
    <!-返回請求標籤-->
    <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!-返回結果資料-->
</介面名稱+Response>

JSON樣本

{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* 返回結果資料 */
}