检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 概述 物联网平台把自身丰富的管理能力通过API的形式对外开放,包括接入点管理、证书管理、设备管理、 产品管理、注册组管理、策略管理等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表。 调用说明
MQTT X.509证书认证设备使用证书策略发放示例 获取设备发放终端节点 表1 设备发放节点列表 区域名称 区域 终端节点(Endpoint) 端口 协议 华北-北京四 cn-north-4 iot-bs.cn-north-4.myhuaweicloud.com 8883 MQTTS
API 接入点管理 设备CA证书管理 设备管理 产品管理 注册组管理 发放策略管理
project_id 是 String 项目ID。 最小长度:1 最大长度:32 device_id 是 String 设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。(生成规则为"product_id" + "_" + "node_id"拼接而成) 最小长度:1 最大长度:128
最大长度:24 start_time 否 String 查询设备注册时间在startTime之后的记录,格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。 end_time 否 String 查询设备注册时间在endTime之前的记录,格式:yyyyMMdd
exist 证书名已存在 请确认证书信息是否正确 400 IoTDP.100216 certificate parsing error 证书解析失败 请确认证书内容是否正确 400 IoTDP.100217 certificate already exists 证书已存在 请更换证书
静态策略 概述 静态策略,即设备关键字模糊匹配的发放策略。每条静态策略实例指:匹配上该策略实例的设备,将会被发放到该条策略实例关联的设备接入实例的对应资源空间(即应用)下。 设备匹配静态策略实例的机制为: 设备的发放策略为“静态策略”,设备的关键字来源字符串包含某一静态策略实例的
使用场景 全球设备,单点发放 无需人工干预,在设备出厂时对设备的接入信息进行硬编码,设备统一烧录全球统一的设备发放接入信息,通过全球统一的设备发放服务实现跨区域的自动发放能力。 多用户隔离 设备出厂前统一在设备发放管理和接入,根据配置实现出厂后接入到不同用户的IoT平台。 动态完成不同批次设备初始化配置
注册组 MQTT证书接入的设备,可以在设备发放创建一个注册组,绑定对应的CA证书和自定义策略,可以实现批量设备的自注册,实现设备一键上电即可上云的动作,可在注册组详情中查看该注册组下所有的设备。 进入“设备-注册组列表”界面,单击左上角“新增注册组”。 图1 新增注册组 按照下方参数说明填写关键参数信息后,完成创建。
创建发放策略 功能介绍 创建发放策略 URI POST /v5/iotps/{project_id}/allocation-strategies/{strategy_type} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1
查询发放策略列表 功能介绍 查询发放策略列表 URI GET /v5/iotps/{project_id}/allocation-strategies/{strategy_type} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。
验证CA证书 对于已上传的CA证书,平台要求用户完成“验证CA证书”过程,以验证用户具备该CA证书的签发能力。 操作步骤 登录设备发放控制台。 在设备发放控制台,左侧导航窗格中,选择“证书”,单击“证书列表”条目的操作栏中的“验证证书”。 图1 上传CA证书完成页 在上传验证证书
查询单个发放策略实例 功能介绍 查询单个发放策略实例 URI GET /v5/iotps/{project_id}/allocation-strategies/{strategy_type}/{strategy_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
创建注册组 功能介绍 应用服务器可调用此接口在物联网平台创建一个注册组。 URI POST /v5/iotps/{project_id}/registration-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 最小长度:1
注册设备 功能介绍 应用服务器可调用此接口在物联网平台注册一个设备,仅在注册后设备才可以接入物联网平台。 URI POST /v5/iotps/{project_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。
功能简介 设备发放服务主要用于设备在多个IoT平台实例的发放、接入和迁移。设备在出厂时只需要烧录一个地址,然后在云上通过配置或者通过代码控制不同的设备接入不同的IoT平台。设备上电后收到设备发放下发的新的物联网平台连接地址,直接连接新的地址,免去二次烧录设备信息,同时还支持初始化的设备信息同步。
签发设备证书 已上传并验证CA证书后,就可以使用此CA证书签发设备证书供设备使用。 操作步骤 使用OpenSSL工具为设备证书生成密钥对,即”设备证书(客户端证书)私钥”。 openssl genrsa -out deviceCert.key 2048 使用密钥对生成证书签名请求文件:
设备自动注册安全接入示例 场景说明 平台基于客户业务安全考虑,只有将设备的基本信息(例如设备ID、鉴权信息)注册到平台后,设备才能使用成功注册后的设备ID和鉴权信息接入物联网平台。当用户注册的设备不断增多时,如何安全且高效地注册设备变得尤为关键。 一种方案是,使用批量注册模板或者
授权 概述 授权,即授权关系,是两个租户在设备发放中建立的一种租户间单向的资源共享的关系。 通过授权功能,授权租户向被授权租户共享授权租户下的设备接入实例,被授权租户可使用授权租户的设备接入实例作为发放策略的目的接入点,从而实现跨账号发放设备的能力。 创建授权关系 被授权方进入“