检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
产品管理 查询产品列表 查询产品 父主题: API
设备管理 注册设备 查询设备列表 查询设备 修改设备 删除设备 操作设备 重置设备指纹 发放设备 父主题: API
接入点管理 查询接入点列表 查询接入点详情 查询接入点下的应用 父主题: API
设备CA证书管理 上传设备CA证书 获取设备CA证书列表 删除设备CA证书 查询单个设备CA证书 更新单个设备CA证书 生成CA证书验证码/验证设备CA证书 父主题: API
注册组管理 查询注册组列表 创建注册组 删除注册组 查询注册组详情 删除注册组 修改注册组 查询注册组下的设备 父主题: API
发放策略管理 查询发放策略列表 创建发放策略 查询单个发放策略实例 删除发放策略实例 父主题: API
注册设备 功能介绍 应用服务器可调用此接口在物联网平台注册一个设备,仅在注册后设备才可以接入物联网平台。 URI POST /v5/iotps/{project_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。
auth_type 否 String 认证类型 register_group_secret 否 String 设备组密钥,设置该字段时平台将设备密钥置为指定值,若不设置则由平台自动生成。 最小长度:44 最大长度:172 init_config 否 String 注册组的初始化配置。必须为json字符串
备秘钥,携带指定秘钥时平台将设备秘钥重置为指定的秘钥,不携带秘钥时平台将自动生成一个新的随机秘钥返回。注意:NB设备秘钥由于协议特殊性,只支持十六进制秘钥接入。 triggerBootstrapDevice:重引导设备。应用服务器可调用此接口重引导设备,平台向设备下发重引导命令,
删除注册组 功能介绍 应用服务器可调用此接口在物联网平台上删除指定注册组。 URI DELETE /v5/iotps/{project_id}/registration-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。
使用前必读 概述 物联网平台把自身丰富的管理能力通过API的形式对外开放,包括接入点管理、证书管理、设备管理、 产品管理、注册组管理、策略管理等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表。 调用说明
删除注册组 功能介绍 应用服务器可调用此接口在物联网平台上删除指定注册组。 URI DELETE /v5/iotps/{project_id}/registration-groups/{registration_group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
false:通过非安全协议方式接入。 缺省值:true timeout 否 Integer 设备验证码的有效时间,单位:秒,默认值:0 若设备在有效时间内未接入物联网平台并激活,则平台会删除该设备的注册信息。若设置为“0”,则表示设备验证码不会失效(建议填写为“0”)。 最小值:0 最大值:2147483647 缺省值:0
产品ID,用于唯一标识一个产品,在物联网平台的SP Portal上导入产品模型后由平台分配获得。使用自定义策略场景需要填该字段,非自定义策略不用填该字段 region_id 否 String 区域ID,用于区分不同的区域。 app_id 否 String 应用ID。此参数为非必选参数,用于兼容平台老用户存在多
最大长度:32 device_id 是 String 参数说明:设备ID,用于唯一标识一个设备。在注册设备时直接指定,或者由物联网平台分配获得。由物联网平台分配时,生成规则为"product_id" + "" + "node_id"拼接而成。 取值范围:长度不超过128,只允许字母、数字、下划线()、连接符(-)的组合。
项目ID。 最小长度:1 最大长度:32 product_id 是 String 产品ID,用于唯一标识一个产品,在物联网平台的SP Portal上导入产品模型后由平台分配获得。 表2 Query参数 参数 是否必选 参数类型 描述 region_id 是 String 区域ID,用于区分不同的区域。
String 设备证书名称,CA证书选择云证书管理服务的CA证书接入需要填写该字段。此名称会也即设备证书使用者的CommanName device_cert_validity Integer 生成设备证书的有效期。CA证书选择云证书管理服务的CA证书可填写该字段。 最小值:1 最大值:10
删除设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台删除设备的CA证书 URI DELETE /v5/iotps/{project_id}/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
设备自动注册安全接入示例 场景说明 平台基于客户业务安全考虑,只有将设备的基本信息(例如设备ID、鉴权信息)注册到平台后,设备才能使用成功注册后的设备ID和鉴权信息接入物联网平台。当用户注册的设备不断增多时,如何安全且高效地注册设备变得尤为关键。 一种方案是,使用批量注册模板或者循环调用平台应用侧注册设
Query参数 参数 是否必选 参数类型 描述 product_id 否 String 设备关联的产品ID,用于唯一标识一个产品模型,在管理门户导入产品模型后由平台分配获得。 最小长度:1 最大长度:36 gateway_id 否 String 网关ID,用于标识一个网关设备。当设备是直连