本文檔主要介紹調用物聯網平臺云端API的請求結構和請求示例。
請求結構
您可以通過發送HTTP或HTTPS請求調用物聯網平臺API。
請求結構如下:
http://Endpoint/?Action=xx&Parameters
參數 | 說明 |
---|---|
Endpoint | 調用云服務的接入地址。物聯網平臺的接入地址格式:iot.${RegionId}.aliyuncs.com 。其中,變量${RegionId}需替換為您的物聯網平臺服務的地域代碼。阿里云地域代碼,請參見地域和可用區。
接入地址示例:
|
Action | 要執行的操作,即云端API接口的名稱。例如,調用Pub接口向指定Topic發布消息,Action對應的值就是Pub,即Action=Pub 。
|
Parameters | 請求參數。每個參數之間用(&)符號分隔。
請求參數由公共請求參數和API自定義參數組成。公共參數中包含API版本號、身份驗證等信息。 |
https://iot.cn-shanghai.aliyuncs.com/?Action=Pub
&Format=XML
&Version=2018-01-20
&Signature=Pc5WB8gok***1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=LTAI4***iW5j3
&Timestamp=2017-07-19T12:00:00Z
&RegionId=cn-shanghai
...
API在線調試
阿里云OpenAPI開發者門戶提供API在線調試工具。在API調試頁面,您可以快速檢索和體驗調用API。系統會根據您輸入的參數同步生成各語言SDK的代碼示例。各語言SDK代碼示例顯示在頁面右側SDK示例頁簽下供您參考。在調用結果頁簽下,可查看API調用的真實請求URL和JSON格式的返回結果。
API授權
為了確保您的賬號安全,建議您使用RAM用戶調用API。如果您使用RAM用戶調用物聯網平臺API,您需要為該RAM用戶創建、授予相應的授權策略。
為RAM用戶授權調用API,請參見IoT API 授權映射表。