检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 概述 物联网平台把自身丰富的管理能力通过API的形式对外开放,包括接入点管理、证书管理、设备管理、 产品管理、注册组管理、策略管理等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表。 调用说明
制作CA证书 本文以Windows环境为例,介绍通过Openssl工具制作CA证书和验证证书的方法。 以下“生成密钥对(rootCA.key)”和“生成CA证书(rootCA.crt)”为操作过程中需要使用到的两个文件。 制作CA证书 在浏览器中访问这里,下载并进行安装OpenSSL工具,安装完成后配置环境变量。
被请求的页面需要用户名和密码。 403 Forbidden 服务器已经理解请求,但是拒绝执行它。 404 Not Found 资源不存在,资源未找到。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。
创建注册组 功能介绍 应用服务器可调用此接口在物联网平台创建一个注册组。 URI POST /v5/iotps/{project_id}/registration-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 最小长度:1
查询单个设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台查询设备的CA证书 URI GET /v5/iotps/{project_id}/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
查询注册组详情 功能介绍 应用服务器可调用此接口查询物联网平台中注册组详情。 URI GET /v5/iotps/{project_id}/registration-groups/{registration_group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
修改注册组 功能介绍 应用服务器可调用此接口修改物联网平台中指定注册组的基本信息。 URI PUT /v5/iotps/{project_id}/registration-groups/{registration_group_id} 表1 路径参数 参数 是否必选 参数类型 描述
上传设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台上传设备的CA证书 URI POST /v5/iotps/{project_id}/certificates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1
获取设备CA证书列表 功能介绍 应用服务器可调用此接口在物联网平台获取设备的CA证书列表 URI GET /v5/iotps/{project_id}/certificates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1
查询设备列表 功能介绍 应用服务器可调用此接口查询物联网平台中的设备信息列表。 URI GET /v5/iotps/{project_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1 最大长度:32
更新单个设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台更新设备的CA证书 URI PUT /v5/iotps/{project_id}/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
查询注册组列表 功能介绍 应用服务器可调用此接口查询物联网平台中的注册组信息列表。 URI GET /v5/iotps/{project_id}/registration-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。
删除设备 功能介绍 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。若设备已发放成功,此接口将级联删除设备接入实例中的该设备。 URI DELETE /v5/iotps/{project_id}/devices/{device_id}
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 对设备执行的操作,当前仅支持: resetDeviceSecret:重置秘钥。应用服务器
查询产品 功能介绍 应用服务器可调用此接口查询已导入物联网平台的指定产品模型详细信息,包括产品模型的服务、属性、命令等。 URI GET /v5/iotps/{project_id}/products/{product_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
重置设备指纹 功能介绍 应用服务器可调用此接口重置设备指纹。携带指定设备指纹时将之重置为指定值;不携带时将之置空,后续设备第一次接入时,该设备指纹的值将设置为第一次接入时的证书指纹。 URI POST /v5/iotps/{project_id}/devices/{device_
生成CA证书验证码/验证设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台生成CA证书验证码或验证设备的CA证书 URI POST /v5/iotps/{project_id}/certificates/{certificate_id}/action 表1 路径参数 参数
以及设备或注册组,通过设备南向操作触发函数,将设备发放到指定目的接入点(设备接入实例)。 后续操作包括: 添加自定义策略实例; 注册设备或创建注册组; 南向接口:MQTT CONNECT连接鉴权、设备请求引导消息、设备接收引导消息。 最佳实践: 结合函数服务通过自定义策略发放证书认证的设备。
步骤4中,设备将该证书发送给设备发放设备侧。 设备 CA证书 CA证书(设备CA证书/客户端CA证书) 步骤5中,设备发放设备侧使用该CA证书验证来自设备的客户端证书。用户通过应用侧上传该证书到设备发放平台。 用户 通常为自签发 样例中各类证书常用文件名: 表2 证书 文件名 MQTT.fx中的字段名 服务端证书 -
接入点管理 查询接入点列表 查询接入点详情 查询接入点下的应用 父主题: API