检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 概述 物联网平台把自身丰富的管理能力通过API的形式对外开放,包括接入点管理、证书管理、设备管理、 产品管理、注册组管理、策略管理等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表。 调用说明
CONNECT连接鉴权 接口功能 设备发放平台设备侧支持MQTT协议的connect消息接口,接口规范参考MQTT标准规范,鉴权通过后建立设备与平台间的MQTT连接。 设备发放平台目前只支持MQTTS接入,设备通过connect消息接口和平台建立MQTT连接时,需要使用服务端CA证
设备安全认证 设备接入设备发放和接入平台之前,需要通过身份认证。当前,物联网平台支持密钥认证和X.509证书认证两种认证方式进行设备身份认证。 密钥认证 创建设备时,认证方式选择密钥认证,用户为设备指定或者平台自动生成设备密钥。设备接入平台时,携带密钥(为避免密钥在通信链路中直接
设备发放平台地址作为引导服务器地址),引导物联网设备在初次上电时获得正确的目标物联网平台地址,继而完成设备与平台的建链过程。保证设备安全可靠的按业务目标上线,最大程度上减少人为干预的错误可能。 流程如下: 首先确认用户是否开通设备接入服务(物联网平台)。 在设备发放平台创建设备的
功能简介 设备发放服务主要用于设备在多个IoT平台实例的发放、接入和迁移。设备在出厂时只需要烧录一个地址,然后在云上通过配置或者通过代码控制不同的设备接入不同的IoT平台。设备上电后收到设备发放下发的新的物联网平台连接地址,直接连接新的地址,免去二次烧录设备信息,同时还支持初始化的设备信息同步。
错误码 功能说明 公有云的扩展接口发生400、500等错误时,会有自定义错误信息返回,本章节为您介绍每个错误码的含义。 返回体格式 HTTP状态码 400 返回体样例 { "error_code": 104902, "error_desc": "get cloud
设备自动注册安全接入示例 场景说明 平台基于客户业务安全考虑,只有将设备的基本信息(例如设备ID、鉴权信息)注册到平台后,设备才能使用成功注册后的设备ID和鉴权信息接入物联网平台。当用户注册的设备不断增多时,如何安全且高效地注册设备变得尤为关键。 一种方案是,使用批量注册模板或者循环调用平台应用侧注册设
CA证书(设备CA证书/客户端CA证书) server.crt - 双向认证,即双向证书认证,与单向认证中不同的是,不仅包含单向认证中的设备对平台的证书验证步骤,还包含了平台对设备的证书验证步骤。
注册设备 功能介绍 应用服务器可调用此接口在物联网平台注册一个设备,仅在注册后设备才可以接入物联网平台。 URI POST /v5/iotps/{project_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。
默认生命周期:设备开机后,如果没有归属物联网平台地址,且在默认生命周期内没有收到设备发放服务下发的地址,则根据注册的设备发放服务地址,向物联网平台发起请求。平台返回连接信息后,设备覆盖本地的注册的物联网平台地址,向指定的物联网平台地址发起注册。默认值为86400秒,最大值(7*86400秒)。
最大值:50 缺省值:10 marker 否 String 上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的数据记录ID也会越大。若填写marker,则本次只查询记录ID小于marke
删除设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台删除设备的CA证书 URI DELETE /v5/iotps/{project_id}/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
最大值:50 缺省值:10 marker 否 String 上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的数据记录ID也会越大。若填写marker,则本次只查询记录ID小于marke
上传设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台上传设备的CA证书 URI POST /v5/iotps/{project_id}/certificates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1
删除注册组 功能介绍 应用服务器可调用此接口在物联网平台上删除指定注册组。 URI DELETE /v5/iotps/{project_id}/registration-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。
最小长度:0 最大长度:256 marker 否 String 上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的数据记录ID也会越大。若填写marker,则本次只查询记录ID小于marke
删除注册组 功能介绍 应用服务器可调用此接口在物联网平台上删除指定注册组。 URI DELETE /v5/iotps/{project_id}/registration-groups/{registration_group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
auth_type 否 String 认证类型 register_group_secret 否 String 设备组密钥,设置该字段时平台将设备密钥置为指定值,若不设置则由平台自动生成。 最小长度:44 最大长度:172 init_config 否 String 注册组的初始化配置。必须为json字符串
false:通过非安全协议方式接入。 缺省值:true timeout 否 Integer 设备验证码的有效时间,单位:秒,默认值:0 若设备在有效时间内未接入物联网平台并激活,则平台会删除该设备的注册信息。若设置为“0”,则表示设备验证码不会失效(建议填写为“0”)。 最小值:0 最大值:2147483647 缺省值:0
查询单个设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台查询设备的CA证书 URI GET /v5/iotps/{project_id}/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是