- 最新动态
- 产品介绍
- 价格说明
- 快速入门
- 开发指南
- 用户指南
- 最佳实践
- API参考
-
SDK参考
- SDK介绍(联通用户专用)
- 应用侧JAVA SDK API参考(联通用户专用)
- 应用侧Python SDK API参考(联通用户专用)
- 设备侧Agent Lite API参考(C)(联通用户专用)
- 设备侧Agent Lite API参考(Android)(联通用户专用)
- 设备侧Agent Lite API参考(Java)(联通用户专用)
-
常见问题
- 热门问题(联通用户专用)
-
方案咨询(联通用户专用)
- 开发中心、设备接入和设备管理的差异是什么?
- IAM子用户或子项目是否可以开通物联网平台服务?
- 物联网平台支持在华为云的哪些区域开通?
- 如何成为华为IoT生态合作伙伴?
- 物联网平台支持哪些接入方式和协议?
- 华为是否提供模组/硬件终端/应用软件等?
- 设备接入模拟器HubSimulator是否能在设备管理使用?
- 设备接入服务如何获取设备数据?
- 物联网平台的应用和设备可以无限创建吗?
- 物联网平台支持批量注册设备吗?
- 物联网平台对应用和设备有消息流控吗?
- 开发中心单个应用允许接入设备数是多少?
- 数据在物联网平台的保存时间是多久?
- 物联网平台支持的DTLS加密算法有哪些?
- 物联网平台支持二进制大小端模式切换吗?
- 什么是NB-IoT?
- 物联网平台支持的硬件架构和使用的相关组件有哪些?
-
设备集成(联通用户专用)
- 如何获取设备和应用对接地址?
- 如何下载LiteOS IDE/IoT Studio?
- 物联网平台允许一个IMEI号注册多个设备吗?
- 如何设置设备名称?
- IoT设备如何激活?
- 物联网平台如何切换设备的在线/离线状态?
- 通过网关接入的子设备,平台如何识别是哪一个设备?
- deviceId、nodeId和IMEI有什么对应关系?
- Agent Lite和Agent Tiny有什么区别?
- 使用Agent Lite接入的网关设备gwbindinfo.json文件丢失如何处理?
- 运行Agent Lite Java Demo报UnsatisfiedLinkError错误怎么处理?
- 设备如何发送文件至物联网平台?
- 开发中心模拟设备如何上报负数?
- 开发中心支持哪几种省电模式?
- 开发中心支持数据转发吗?
- 开发中心没有设备分组和批量添加设备,怎么办?
- 如何检测NB网络信号?
- NB模组附着网络失败如何处理?
- NB模组绑定设备失败怎么办?
- NB模组无法正常上报数据怎么办?
- NB设备上报数据为字符串时如何转换为二进制编码?
- NB设备接入时,出现513错误?
- 为什么执行AT+CUFN=1会返回error?
- 平台向NB-IoT设备缓存下发命令,为什么设备一直收到同一条控制命令?
- AT+CGDCONT=1, CTNB是什么?
- NB-IoT设备如何选择PSM、DRX、eDRX模式?
- 应用集成(联通用户专用)
-
订阅推送(联通用户专用)
- 调用订阅接口时,回调地址如何获取?
- 应用服务器如何收到命令状态变化的通知?
- 如何获取证书?
- 回调地址可以使用域名吗?
- 订阅后消息推送失败,例如提示503如何处理?
- 应用服务器收到数据,但是平台显示推送失败?
- 应用服务器只有内网地址,能否订阅成功?
- 调用订阅接口时,提示回调地址不合法?
- 物联网平台只支持HTTPS的回调地址吗?
- 回调地址可以修改吗?
- 推送证书失效怎么处理?
- 调用删除单个订阅接口时,subscriptionId如何获取?
- 设备数据变化通知和批量设备数据变化通知的区别是什么?
- 应用服务器如何获取物联网平台推送消息时使用的地址?
- 物联网平台订阅推送是否具有重推机制?
- 为什么设备上报一条数据后应用服务器会收到多条推送?
- 在同一个应用下,平台可以将不同设备上报的数据,推送到两个服务器吗?
- NB-IoT设备已订阅消息确认和命令响应通知,为何应用服务器收不到推送消息?
- 数据上报(联通用户专用)
- 命令下发(联通用户专用)
- 产品模型/Profile(联通用户专用)
- 编解码插件(联通用户专用)
- 软/固件升级(联通用户专用)
- 文档下载
- 通用参考
链接复制成功!
构造请求
请求URI
请求URI由如下部分组成。
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
参数 |
说明 |
---|---|
URI-scheme |
传输请求的协议,当前所有API均采用HTTPS协议。 |
Endpoint |
承载REST服务端点的服务器地址,为“host:port”格式,host为服务器的访问域名或IP,port为服务器的访问端口,您可以参考平台对接信息获取应用的接入地址和端口信息。 例如设备管理服务在“华北-北京四”区域的应用对接地址为“iot-api.cn-north-4.myhuaweicloud.com”,端口为“8743”,所以Endpoint为“iot-api.cn-north-4.myhuaweicloud.com:8743”。 |
resource-path |
资源路径,即API访问路径。从具体API的URI信息处获取,例如鉴权接口的resource-path为“/iocm/app/sec/v1.1.0/login”。 |
query-string |
查询参数,可选,格式为“参数名=参数取值”,例如“pageSize=10”,表示每页最多显示10条查询记录。 查询参数与resource-path之间以“?”分隔,多个查询参数之间以“&”分隔。 |
例如您需要获取“华北-北京四”区域设备管理服务的accessToken,查询到的Endpoint为“iot-api.cn-north-4.myhuaweicloud.com:8743”,并在鉴权接口的URI信息处找到resource-path为“/iocm/app/sec/v1.1.0/login”,拼接起来的请求URI如下所示。
https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/sec/v1.1.0/login
以批量查询设备信息接口为例,带query-string参数的请求URI如下所示。
https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/dm/v1.4.0/devices?pageNo=0&pageSize=10
请求方法
HTTP请求方法(也称为操作),它告诉服务你正在请求什么类型的操作。
方法 |
说明 |
---|---|
POST |
请求服务器新增资源或执行特殊操作。 |
GET |
请求服务器返回指定资源。 |
PUT |
请求服务器更新指定资源。 |
DELETE |
请求服务器删除指定资源,如删除对象等。 |
在鉴权接口的URI信息处,您可以看到其请求方法为“POST”,则其请求为:
POST https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/sec/v1.1.0/login
请求消息头
附加请求头(header)字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。
参数 |
是否必选 |
说明 |
---|---|---|
Content-Type |
必选 |
消息体的媒体类型,默认取值为“application/json”。
|
app_key |
鉴权接口不选 其他接口必选 |
|
Authorization |
鉴权接口不选 其他接口必选 |
访问物联网平台的认证信息,值为“Bearer {accessToken}”,其中{accessToken}为调用鉴权接口返回的accessToken。 |
Token在计算机系统中代表临时令牌的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。Token是有有效时间的,Token过期后需要重新认证并获取新的
对于鉴权接口,由于不需要认证,所以只添加Content-Type即可,添加消息头后的请求如下所示。
POST https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/sec/v1.1.0/login Content-Type: application/x-www-form-urlencoded
对于其他接口,还需要在请求消息头中添加app_key和Authorization,以注册设备(验证码方式)接口为例,添加消息头后的请求如下所示,“******”需要根据实际值填写。
POST https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/reg/v1.1.0/deviceCredentials Content-Type: application/json app_key: ****** Authorization: Bearer ******
请求消息体
请求消息体通常以结构化格式发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
对于鉴权接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,“******”需要根据实际值填写。
POST https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/sec/v1.1.0/login Content-Type: application/x-www-form-urlencoded appId=******&secret=******
鉴权接口的Content-Type为“application/x-www-form-urlencoded”,其消息体格式与Content-Type值为“application/json”时有差别。以注册设备(验证码方式)接口为例,其请求示例如下所示,“******”需要根据实际值填写。
POST https://iot-api.cn-north-4.myhuaweicloud.com:8743/iocm/app/reg/v1.1.0/deviceCredentials Content-Type: application/json app_key: ****** Authorization: Bearer ****** { "nodeId": "******", "productId": "******", "timeout": 0 }
到这里为止这个请求需要的内容就具备齐全了,您可以使用cURL、Postman或直接编写代码等方式发送请求调用API。