检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
鉴权类型。支持秘钥认证接入(SECRET)和证书认证接入(CERTIFICATES)。使用秘钥认证接入方式(SECRET)填写secret字段,使用证书认证接入方式(CERTIFICATE)填写fingerprint字段,如果CA证书选择云证书管理服务的CA证书,不需要填写finger
注册组 MQTT证书接入的设备,可以在设备发放创建一个注册组,绑定对应的CA证书和自定义策略,可以实现批量设备的自注册,实现设备一键上电即可上云的动作,可在注册组详情中查看该注册组下所有的设备。 进入“设备-注册组列表”界面,单击左上角“新增注册组”。 图1 新增注册组 按照下方参数说明填写关键参数信息后,完成创建。
策略类型。目前支持静态策略(base),证书策略(certificates)和自定义策略(functions) 缺省值:functions certificate_id 否 String 证书id。使用第三方上传CA,证书ID为设备发放服务生成的证书id,使用云证书CA,证书ID为云证书服务生成的证书ID。 最小长度:0
示例 注册 证书认证 证书策略 MQTT X.509证书认证设备使用证书策略发放示例 注册 密钥认证 静态策略 MQTT 密钥设备使用静态策略发放示例 注册组 证书认证 自定义策略 MQTT 注册组自定义策略发放示例 注册组 云证书认证 证书策略 MQTT 华为云证书注册组发放示例
说明 authType String 认证类型。可选 SECRET 和 CERTIFICATES。 secret String 设备密钥信息,当认证类型为 SECRET 时携带。 certInfo CertInfoPara 证书信息,当认证类型为 CERTIFICATES 时携带。
创建设备时,需要使用设备接入服务创建的产品 设备接入服务(IoT Device Access,IoTDA) 创建产品 创建自定义策略时需要使用函数 函数工作流服务(FunctionGraph) 创建并初始化函数 创建证书策略使用云证书时,需要去云证书管理服务创建云证书 云证书管理服务(Cloud Certificate
使用前必读 概述 物联网平台把自身丰富的管理能力通过API的形式对外开放,包括接入点管理、证书管理、设备管理、 产品管理、注册组管理、策略管理等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表。 调用说明
查询接入点详情 GET https://{endpoint}/v5/iotps/{project_id}/access-points/{access_point_id}?region_id={regionId} 响应示例 状态码: 200 OK { "access_point_id"
应用服务器可调用此接口重置设备指纹。携带指定设备指纹时将之重置为指定值;不携带时将之置空,后续设备第一次接入时,该设备指纹的值将设置为第一次接入时的证书指纹。 URI POST /v5/iotps/{project_id}/devices/{device_id}/reset-fingerprint
注意:当前命令通道为同步命令通道。 reset_device_secret 否 ResetDeviceSecret object 表4 ResetDeviceSecret 参数 是否必选 参数类型 描述 secret 是 String 设备秘钥,设置该字段时平台将设备秘钥重置为指定值,若不设置则由平台自动生成。
请求示例 查询接入点列表 GET https://{endpoint}/v5/iotps/{project_id}/access-points 响应示例 状态码: 200 OK { "access_points" : [ { "access_point_id" : "DMP-CNNorth-1-1"
添加自定义策略 按照下方参数说明填写关键参数信息后,单击“确定”。 参数名称 说明 示例 函数 即在函数服务中实现的自定义策略。如果下拉框没有你想要的函数,可以单击创建新函数来实现你的自定义策略需求。 将需要通过函数“function”发放的设备发放至华北-北京四的物联网平台。
"provision_info" : { "access_point" : { "access_point_id" : "cn-north-4", "access_point_name" : "cn-north-4",
String 项目ID。 最小长度:1 最大长度:32 strategy_type 是 String 策略类型。支持静态策略(base)、证书策略(certificates)、自定义策略(functions)多种策略类型。 缺省值:base strategy_id 是 String
策略类型。目前支持静态策略(base),证书策略(certificates)和自定义策略(functions) 缺省值:functions certificate_id 否 String 证书id。使用第三方上传CA,证书ID为设备发放服务生成的证书id,使用云证书CA,证书ID为云证书服务生成的证书ID。 最小长度:0
fx接入设备发放示例 MQTT 密钥设备使用静态策略发放示例 MQTT X.509证书认证设备使用证书策略发放示例 MQTT 注册组自定义策略发放示例 MQTT 华为云X.509证书认证设备使用证书策略发放示例 MQTT 华为云证书注册组发放示例 MQTT 注册组静态策略发放示例 MQTT 注册组密钥认证静态策略发放示例
是 String 区域ID,用于区分不同的区域。 最小长度:1 最大长度:64 access_point_id 是 String 接入点id,用于区分不同的区域。 最小长度:1 最大长度:64 app_id 否 String 应用id。此参数为非必选参数,存在多资源空间的用户需要
查询单个设备CA证书 应用服务器可调用此接口在物联网平台查询设备的CA证书。 更新单个设备CA证书 应用服务器可调用此接口在物联网平台更新设备的CA证书。 生成CA证书验证码/验证设备CA证书 应用服务器可调用此接口在物联网平台生成CA证书验证码或验证设备的CA证书。 设备管理 API 说明
描述 certificate_id String CA证书id 最小长度:0 最大长度:256 cert_type String 证书类型 strategy_type String 策略类型。目前支持静态策略(base),证书策略(certificates)和自定义策略(functions)。
放策略选择“静态策略”,创建设备。 实际使用中,用户可以使用批量注册功能注册大量设备。下载批量注册模板,按照模板说明正确填写后上传批量注册文件以批量注册设备。建议每个设备名称的以策略的关键字开头(比如策略关键字为Model1,设备名称为Model1_XXX001)。 图3 设备列表