公共參數(shù)
本文檔介紹物聯(lián)網(wǎng)平臺(tái)云端API的公共請(qǐng)求參數(shù)和公共返回參數(shù)。
公共請(qǐng)求參數(shù)
公共請(qǐng)求參數(shù)是調(diào)用每個(gè)API時(shí)都需要使用的請(qǐng)求參數(shù)。
名稱(chēng) | 類(lèi)型 | 是否必需 | 描述 |
Format | String | 否 | 返回值的類(lèi)型,支持JSON和XML類(lèi)型。默認(rèn)為XML。 |
Version | String | 是 | API版本號(hào),為日期形式: |
AccessKeyId | String | 是 | 阿里云頒發(fā)給用戶(hù)的訪問(wèn)服務(wù)所用的密鑰ID。 登錄阿里云控制臺(tái),將光標(biāo)移至賬號(hào)頭像上,然后單擊accesskeys,跳轉(zhuǎn)至用戶(hù)信息管理頁(yè),即可創(chuàng)建和查看AccessKey。 |
Signature | String | 是 | 簽名結(jié)果串。 |
SignatureMethod | String | 是 | 簽名方式,目前支持HMAC-SHA1。 |
Timestamp | String | 是 | 請(qǐng)求的時(shí)間戳。日期格式按照ISO8601標(biāo)準(zhǔn)表示,并需要使用UTC時(shí)間。格式為 例如, |
SignatureVersion | String | 是 | 簽名算法版本。目前版本是1.0。 |
SignatureNonce | String | 是 | 唯一隨機(jī)數(shù)。用于防止網(wǎng)絡(luò)重放攻擊。用戶(hù)在不同請(qǐng)求中要使用不同的隨機(jī)數(shù)值。 |
RegionId | String | 是 | 設(shè)備所在地域(與控制臺(tái)上的地域?qū)?yīng)),如cn-shanghai。 |
示例
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
公共返回參數(shù)
API返回結(jié)果采用統(tǒng)一格式,返回2xx HTTP狀態(tài)碼代表調(diào)用成功;返回4xx或5xx HTTP狀態(tài)碼代表調(diào)用失敗。調(diào)用成功返回的數(shù)據(jù)格式有XML和JSON兩種。可以在發(fā)送請(qǐng)求時(shí),指定返回的數(shù)據(jù)格式。默認(rèn)為XML格式。
每次接口調(diào)用,無(wú)論成功與否,系統(tǒng)都會(huì)返回一個(gè)唯一識(shí)別碼RequestId。
調(diào)用成功的返回示例。
XML格式
<?xml version="1.0" encoding="UTF-8"?> <!--結(jié)果的根結(jié)點(diǎn)--> <接口名稱(chēng)+Response> <!--返回請(qǐng)求標(biāo)簽--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--返回結(jié)果數(shù)據(jù)--> </接口名稱(chēng)+Response>
JSON格式
{ "RequestId": "4C467B38-3910-447D-87BC-AC049166F216" /* 返回結(jié)果數(shù)據(jù) */ }
調(diào)用失敗的返回示例。
調(diào)用接口出錯(cuò)后,將不會(huì)返回結(jié)果數(shù)據(jù)。可根據(jù)錯(cuò)誤碼來(lái)定位錯(cuò)誤原因。
當(dāng)調(diào)用出錯(cuò)時(shí),HTTP請(qǐng)求返回一個(gè)4xx或5xx的HTTP狀態(tài)碼。返回的消息體中是具體的錯(cuò)誤代碼及錯(cuò)誤信息。另外,還包含一個(gè)全局唯一的請(qǐng)求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." }