检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 接入点管理 设备CA证书管理 设备管理 产品管理 注册组管理 发放策略管理
如何调用API 构造请求 认证鉴权 返回结果
操作设备 应用服务器可调用此接口对设备执行操作。 发放设备 应用服务器可调用此接口对设备执行发放操作。 产品管理 API 说明 查询产品列表 应用服务器可调用此接口查询已导入物联网平台的产品模型信息列表,了解产品模型的概要信息。 查询产品 应用服务器可调用此接口查询已导入物联网平台的指
接口说明 MQTT CONNECT连接鉴权 设备请求引导消息 设备接收引导信息
删除设备 功能介绍 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。若设备已发放成功,此接口将级联删除设备接入实例中的该设备。 URI DELETE /v5/iotps/{project_id}/devices/{device_id}
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:0 最大长度:65535 响应参数 状态码: 200 表4 响应Body参数
文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说
的状态,完整的状态码列表请参见状态码。 对于查询接入点列表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”等。 对于查询接入点列表接口,平台会返回“Content-type”、Date等消息头。
产品管理 查询产品列表 查询产品 父主题: API
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scop
注册组管理 查询注册组列表 创建注册组 删除注册组 查询注册组详情 删除注册组 修改注册组 查询注册组下的设备 父主题: API
接入点管理 查询接入点列表 查询接入点详情 查询接入点下的应用 父主题: API
设备管理 注册设备 查询设备列表 查询设备 修改设备 删除设备 操作设备 重置设备指纹 发放设备 父主题: API
发放策略管理 查询发放策略列表 创建发放策略 查询单个发放策略实例 删除发放策略实例 父主题: API
上传设备CA证书 获取设备CA证书列表 删除设备CA证书 查询单个设备CA证书 更新单个设备CA证书 生成CA证书验证码/验证设备CA证书 父主题: API
修改设备 功能介绍 应用服务器可调用此接口修改物联网平台中指定设备的基本信息。 URI PUT /v5/iotps/{project_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 对设备执行的操作,当前仅支持: resetDeviceSecret:重置秘钥。应用服务器可调用此接口重置设备秘钥,携
查询产品 功能介绍 应用服务器可调用此接口查询已导入物联网平台的指定产品模型详细信息,包括产品模型的服务、属性、命令等。 URI GET /v5/iotps/{project_id}/products/{product_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
MQTT CONNECT连接鉴权 接口功能 设备发放平台设备侧支持MQTT协议的connect消息接口,接口规范参考MQTT标准规范,鉴权通过后建立设备与平台间的MQTT连接。 设备发放平台目前只支持MQTTS接入,设备通过connect消息接口和平台建立MQTT连接时,需要使用
设备请求引导消息 接口功能 设备向发放服务请求对应设备接入实例的引导信息。 Topic 表1 上报Topic说明 Topic $oc/devices/{device_id}/sys/bootstrap/up 消息发送方 设备 消息接收方 设备发放平台 示例 设备向发放服务发送的payload为空。