公用參數 - - 阿里雲

本文列舉了雲訊息佇列 RocketMQ 版的API的公用請求參數和公用返回參數。

公用請求參數

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

名稱	類型	是否必需	描述
Format	String	否	返回訊息的格式。取值：JSON \| XML（預設值）
productName	String	是	API的產品名稱，直接填寫Ons即可。
domain	String	是	API的存取點domain，規則是`ons.${RegionId}.aliyuncs.com`，該domain對應的地區必須和regionId對應的地區一致。
Version	String	是	API版本號碼，使用YYYY-MM-DD日期格式。取值：2019-02-14
AccessKeyId	String	是	訪問服務使用的金鑰組。如果您以阿里雲帳號（主帳號）或RAM使用者（子帳號）調用API，則此參數為阿里雲帳號或RAM使用者的accessKeyId/accessKeySecret。如果您以RAM角色調用API，則此參數為您擷取的STS安全性權杖中的AccessKey ID或AccessKey Secret。更多資訊，請參見RAM主子帳號授權。
AccessKeySecret	String	是
Signature	String	是	簽名結果串。
SignatureMethod	String	是	簽名方式。取值：HMAC-SHA1
Timestamp	String	是	請求的時間戳記，為日期格式。使用UTC時間按照ISO 8601標準，格式為YYYY-MM-DDThh:mm:ssZ。例如，北京時間2013年01月10日20點0分0秒，表示為2013-01-10T12:00:00Z。
SignatureVersion	String	是	簽名演算法版本。取值：1.0
SignatureNonce	String	是	唯一隨機數，用於防止網路重放攻擊。在不同請求間要使用不同的隨機數值。

請求樣本

https://ons.cn-hangzhou.aliyuncs.com/?Action=OnsRegionList
&Format=JSON
&Version=2019-02-14
&AccessKeyId=key-test
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&Timestamp=2020-01-01T12:00:00Z
&SignatureNonce=1521552885****
&SignatureVersion=1.0
…

公用返回參數

每次介面調用請求，無論成功與否，系統都會返回一個唯一識別碼RequestId。調用API服務後返回資料採用統一格式。返回的HTTP狀態代碼為2xx，代表調用成功；返回的HTTP狀態代碼為4xx或5xx，代表調用失敗。

XML樣本

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

JSON樣本

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