检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
device_cert_validity Integer 生成设备证书的有效期。CA证书选择云证书管理服务的CA证书可填写该字段。 最小值:1 最大值:10 device_cert_id String 设备证书id,设备采用云证书管理服务的CA注册,云证书管理服务生成的设备证书的唯一实例ID secure_access
device_cert_validity Integer 生成设备证书的有效期。CA证书选择云证书管理服务的CA证书可填写该字段。 最小值:1 最大值:10 device_cert_id String 设备证书id,设备采用云证书管理服务的CA注册,云证书管理服务生成的设备证书的唯一实例ID secure_access
String 证书id。使用第三方上传CA,证书ID为设备发放服务生成的证书id,使用云证书CA,证书ID为云证书服务生成的证书ID。 最小长度:0 最大长度:256 func_urn 否 String 函数的URN(Uniform Resource Name),唯一标识函数。 最小长度:1
查询单个设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台查询设备的CA证书 URI GET /v5/iotps/{project_id}/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
更新单个设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台更新设备的CA证书 URI PUT /v5/iotps/{project_id}/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
查询注册组详情 功能介绍 应用服务器可调用此接口查询物联网平台中注册组详情。 URI GET /v5/iotps/{project_id}/registration-groups/{registration_group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
API列表 通过使用设备发放提供的接口,您可以完整的使用设备发放的所有功能。 接入点管理 API 说明 查询接入点列表 查询当前用户可用的接入点列表,包括设备接入企业版实例。 查询接入点详情 查询接入点接入信息。 查询接入点下的应用 查询接入点下的应用。 证书管理 API 说明 上传设备CA证书
header):Topic name,设备发往设备发放平台时,为平台的Topic name,设备接收消息时,为设备的Topic name,具体参见Topic说明。 有效载荷(Payload)中的主要参数填写:为完整的数据上报和命令下发的消息内容,目前是一个JSON对象。 Topic说明 设备
t-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 对设备执行的操作,当前仅支持: resetDeviceSecret:重置秘钥。应用服务器可调用此接口重置设备秘钥,携带指定秘钥时平台将设备秘钥重置为指定的秘钥,不携带秘
生成CA证书验证码/验证设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台生成CA证书验证码或验证设备的CA证书 URI POST /v5/iotps/{project_id}/certificates/{certificate_id}/action 表1 路径参数 参数
证书策略 概述 证书策略,即通过平台认证设备的设备CA证书匹配的发放策略。每条证书策略实例指:匹配上该策略实例的设备,将会被发放到该策略实例关联的设备接入实例的对应资源空间(即应用)下。 设备匹配证书策略实例的机制为: 设备的发放策略指定为“证书策略”时,其认证方式也必须为X.5
否 Integer 生成设备证书的有效期。CA证书选择云证书管理服务的CA证书可填写该字段。 最小值:1 最大值:10 device_cert_id 否 String 设备证书id,设备采用云证书管理服务的CA注册,云证书管理服务生成的设备证书的唯一实例ID secure_access
应用ID。此参数为非必选参数,用于兼容平台老用户存在多应用的场景。存在多应用的用户需要使用该接口时,可以携带该参数查询指定应用下的设备列表,不携带该参数则会查询该用户下所有设备列表。 最小长度:1 最大长度:256 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 device_id String
钥注册组功能。 密钥认证类型的设备组是一个安全性不完备的方案,建议使用证书作为注册组的认证方式。 每个设备的设备代码应该只包含该设备的相应派生设备密钥。 不要在设备代码中包含你的注册组密钥。 泄露的注册组密钥可能会危及所有使用该密钥进行身份验证的设备的安全。 整体流程 添加静态策略
参数说明:设备指纹。设置改字段时平台将设备指纹重置为指定值;不携带时将之置空,后续设备第一次接入时,该设备指纹的值将设置为第一次接入时的证书指纹。 取值范围:长度为40的十六进制字符串或者长度为64的十六进制字符串。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 device_id
使用前必读 概述 物联网平台把自身丰富的管理能力通过API的形式对外开放,包括接入点管理、证书管理、设备管理、 产品管理、注册组管理、策略管理等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表。 调用说明
选择对应设备接入服务区域已创建的应用。在物联网平台中,设备由应用统一管理。 如果对应设备接入服务区域未创建应用,需要前往对应服务创建应用。 创建注册组 MQTT证书接入的设备,可以在设备发放创建一个注册组,绑定对应的CA证书和自定义策略,可以实现批量设备的自注册,实现设备一键上电即可上云的动作,可在注册组详情中查看该注册组下所有的设备。
接入点管理 查询接入点列表 查询接入点详情 查询接入点下的应用 父主题: API
默认生命周期:设备开机后,如果没有归属物联网平台地址,且在默认生命周期内没有收到设备发放服务下发的地址,则根据注册的设备发放服务地址,向物联网平台发起请求。平台返回连接信息后,设备覆盖本地的注册的物联网平台地址,向指定的物联网平台地址发起注册。默认值为86400秒,最大值(7*86400秒)。 导入配置(MQTT协议设备)
String 接入协议 type String 接入类型,目前支持应用接入和设备接入 port Integer 设备/应用接入端口 最小值:0 最大值:65535 public_address Array of strings 实例的公网接入地址(公网接入地址唯一) 最小长度:0 最大长度:65535