本文介紹物聯網平臺云端API的公共請求參數和公共返回參數。
公共請求參數
公共請求參數是調用每個API時都需要使用的請求參數。
名稱 | 類型 | 是否必需 | 描述 |
Format | String | 否 | 返回值的類型,支持JSON和XML類型。默認為XML。 |
Version | String | 是 | API版本號,為日期形式: 可選版本號:
|
AccessKeyId | String | 是 | 阿里云頒發給用戶的訪問服務所用的密鑰ID。 登錄阿里云控制臺,將鼠標指針移至賬號頭像上,然后單擊AccessKey管理,跳轉至AccessKey頁面,即可創建和查看AccessKey。 |
Signature | String | 是 | 簽名結果串。詳細說明,請參見簽名機制。 |
SignatureMethod | String | 是 | 簽名方式,目前支持HMAC-SHA1。 |
Timestamp | String | 是 | 請求的時間戳。日期格式按照ISO8601標準表示,并需要使用UTC時間。格式為 例如, |
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." }