检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口说明 MQTT CONNECT连接鉴权 设备请求引导消息 设备接收引导信息
API列表 通过使用设备发放提供的接口,您可以完整的使用设备发放的所有功能。 接入点管理 API 说明 查询接入点列表 查询当前用户可用的接入点列表,包括设备接入企业版实例。 查询接入点详情 查询接入点接入信息。 查询接入点下的应用 查询接入点下的应用。 证书管理 API 说明 上传设备
API 接入点管理 设备CA证书管理 设备管理 产品管理 注册组管理 发放策略管理
如何调用API 构造请求 认证鉴权 返回结果
查询接入点列表 功能介绍 查询当前用户可用的接入点列表,包括专享版设备管理实例。 URI GET /v5/iotps/{project_id}/access-points 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:
设备请求引导消息 接口功能 设备向发放服务请求对应设备接入实例的引导信息。 Topic 表1 上报Topic说明 Topic $oc/devices/{device_id}/sys/bootstrap/up 消息发送方 设备 消息接收方 设备发放平台 示例 设备向发放服务发送的payload
MQTT CONNECT连接鉴权 接口功能 设备发放平台设备侧支持MQTT协议的connect消息接口,接口规范参考MQTT标准规范,鉴权通过后建立设备与平台间的MQTT连接。 设备发放平台目前只支持MQTTS接入,设备通过connect消息接口和平台建立MQTT连接时,需要使用服务端
删除设备 功能介绍 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。若设备已发放成功,此接口将级联删除设备接入实例中的该设备。 URI DELETE /v5/iotps/{project_id}/devices
构造请求 本节介绍如何构造REST API的请求,并以调用IAM服务的获取用户Token为例说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过此视频了解如何构造请求调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme
设备接收引导信息 接口功能 设备接收发放服务下发的引导信息。 Topic 表1 下发Topic说明 Topic $oc/devices/{device_id}/sys/bootstrap/down 消息发送方 设备发放平台 消息接收方 设备 参数说明 表2 下发参数说明 参数 必选
接入点管理 查询接入点列表 查询接入点详情 查询接入点下的应用 父主题: API
操作设备 功能介绍 应用服务器可调用此接口对设备执行操作。 URI POST /v5/iotps/{project_id}/devices/{device_id}/action 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度
使用前必读 MQTT概述 MQTT标准规范参见《mqtt-v3.1.1-os.pdf》。 MQTT的语法和接口细节,请以此标准为准。设备发放目前仅支持MQTTS/HTTPS这种安全接入的设备进行发放,暂不支持MQTT/HTTP这种非安全接入的设备进行发放。 MQTT消息分为固定报头
产品管理 查询产品列表 查询产品 父主题: API
设备管理 注册设备 查询设备列表 查询设备 修改设备 删除设备 操作设备 重置设备指纹 发放设备 父主题: API
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于查询接入点列表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头
设备CA证书管理 上传设备CA证书 获取设备CA证书列表 删除设备CA证书 查询单个设备CA证书 更新单个设备CA证书 生成CA证书验证码/验证设备CA证书 父主题: API
注册组管理 查询注册组列表 创建注册组 删除注册组 查询注册组详情 删除注册组 修改注册组 查询注册组下的设备 父主题: API
发放策略管理 查询发放策略列表 创建发放策略 查询单个发放策略实例 删除发放策略实例 父主题: API