公用參數 - - 阿里雲

本文介紹物聯網平台雲端API的公用請求參數和公用返回參數。

公用請求參數

公用請求參數是調用每個API時都需要使用的請求參數。

名稱	類型	是否必需	描述
Format	String	否	傳回值的類型，支援JSON和XML類型。預設為XML。
Version	String	是	API版本號碼，為日期形式：`YYYY-MM-DD`。可選版本號碼： `2022-01-01`。 `2018-01-20`。
AccessKeyId	String	是	阿里雲頒發給使用者的訪問服務所用的密鑰ID。登入阿里雲控制台，將滑鼠指標移至帳號頭像上，然後單擊AccessKey管理，跳轉至AccessKey頁面，即可建立和查看AccessKey。
Signature	String	是	簽名結果串。詳細說明，請參見簽名機制。
SignatureMethod	String	是	簽名方式，目前支援HMAC-SHA1。
Timestamp	String	是	請求的時間戳記。日期格式按照ISO8601標準表示，並需要使用UTC時間。格式為`YYYY-MM-ddTHH:mm:ssZ`。例如，`2016-01-04T12:00:00Z`表示北京時間2016年01月04日20點0分0秒。
SignatureVersion	String	是	簽名演算法版本。目前版本是1.0。
SignatureNonce	String	是	唯一隨機數。用於防止網路重放攻擊。使用者在不同請求中要使用不同的隨機數值。
RegionId	String	是	裝置所在地區（與控制台上的地區對應）的ID，如cn-shanghai。物聯網平台支援地區的ID，請參見支援的地區。

樣本：

https://iot.cn-shanghai.aliyuncs.com/
?Format=XML
&Version=2018-01-20
&Signature=Pc5WB***
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=234***
&Timestamp=2018-05-20T12:00:00Z
&RegionId=cn-shanghai

公用返回參數

API返回結果採用統一格式，返回2xx HTTP狀態代碼代表調用成功；返回4xx或5xx HTTP狀態代碼代表調用失敗。調用成功返回的資料格式有XML和JSON兩種。可以在發送請求時，指定返回的資料格式。預設為XML格式。

每次介面調用，無論成功與否，系統都會返回一個唯一識別碼RequestId。

調用成功的返回樣本。

XML格式

2022-01-01版本API

<!--返回請求標籤-->
<RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
<!--返回結果資料-->

2018-01-20版本API

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

JSON格式

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

調用失敗的返回樣本。

調用介面出錯後，將不會返回結果資料。可根據錯誤碼來定位錯誤原因。

當調用出錯時，HTTP請求返回一個4xx或5xx的HTTP狀態代碼。返回的訊息體中是具體的錯誤碼及錯誤資訊。另外，還包含一個全域唯一的請求ID（RequestId）。

XML格式

<?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <Code>UnsupportedOperation</Code>
   <Message>The specified action is not supported.</Message>
</Error>

JSON格式

{
    "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}