检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
的形式对外开放,包括接入点管理、证书管理、设备管理、 产品管理、注册组管理、策略管理等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表。 调用说明 设备发放提供了REST(Representational
状态码 状态码 编码 状态说明 200 OK 请求已成功。 202 Accept 任务提交成功,当前系统繁忙,下发的任务会延迟处理。 204 No Content 请求已成功,无内容返回。 300 multiple choices 被请求的资源存在多个可供选择的响应。 400 Bad
密钥认证设备无法使用证书策略 请确认设备的策略类型和认证方式的正确性 400 IoTDP.100210 Device not exists. 设备不存在 请确认设备信息填写是否正确 400 IoTDP.100211 node id already exists. 设备标识码已存在
发放策略管理 查询发放策略列表 创建发放策略 查询单个发放策略实例 删除发放策略实例 父主题: API
如何调用API 构造请求 认证鉴权 返回结果
更新CA证书 登录设备发放控制台。 在设备发放控制台,左侧导航窗格中,选择“证书”,单击“证书列表”条目的操作栏中的“更新”。 图1 更新CA证书 更新CA证书前,要求该证书未被设备、策略、注册组关联。 更新CA证书后,该证书状态将变为未验证,请重新完成验证CA证书过程。 父主题:
验证CA证书 对于已上传的CA证书,平台要求用户完成“验证CA证书”过程,以验证用户具备该CA证书的签发能力。 操作步骤 登录设备发放控制台。 在设备发放控制台,左侧导航窗格中,选择“证书”,单击“证书列表”条目的操作栏中的“验证证书”。 图1 上传CA证书完成页 在上传验证证书
com/endpoint。 最小长度:1 最大长度:128 edition String 实例版本。Basic:基础版;Enterprise:企业版;Standard:基础版。 最小长度:1 最大长度:256 access_infos Array of AccessInfo objects
产品管理 查询产品列表 查询产品 父主题: API
文件夹下,以管理员身份运行cmd命令行窗口。 生成密钥对(rootCA.key): 生成“密钥对”时输入的密码在生成“证书签名请求文件”、“CA证书”,“验证证书”以及“设备证书”时需要用到,请妥善保存。 openssl genrsa -des3 -out rootCA.key 2048 使用密钥对生成证书签名请求文件:
删除CA证书 登录设备发放控制台。 在设备发放控制台,左侧导航窗格中,选择“证书”,单击“证书列表”条目的操作栏中的“删除”。 图1 删除CA证书 关联了至少一个设备、策略或注册组的CA证书,不允许删除。 请谨慎操作,删除后的CA证书的所有数据将被删除且不可恢复。 父主题: 证书
com/endpoint。 最小长度:1 最大长度:128 edition String 实例版本。Basic:基础版;Enterprise:企业版;Standard:基础版。 最小长度:1 最大长度:256 请求示例 查询接入点列表 GET https://{endpoint}/v5
获取项目ID 从控制台获取项目ID 在调用接口时,部分URI以及请求体中需要填入项目ID,项目ID获取步骤如下: 在华为云首页右上角,点击“控制台”。 在右上角的用户名中选择“我的凭证”。 在“我的凭证”界面,API凭证页签中,查看项目ID。 调用API获取项目ID 项目ID还可
自定义策略实例指示函数关联的设备接入实例,一个函数可关联多个设备接入实例。 设备匹配自定义策略实例的机制为: 设备的发放策略指定为“函数策略”时,需同时指定其关联的函数,设备与自定义策略实例关联同一个函数时,即被认为该设备匹配上该条策略实例; 一个设备可匹配多条自定义策略实例。 创建自定义策略函数
和其他服务的关系 设备发放服务与其他服务的关系如表1所示。 表1 与其他服务的关系列表 交互功能 相关服务 位置 创建设备时,需要使用设备接入服务创建的产品 设备接入服务(IoT Device Access,IoTDA) 创建产品 创建自定义策略时需要使用函数 函数工作流服务(FunctionGraph)
构造请求 本节介绍如何构造REST API的请求,并以调用IAM服务的获取用户Token为例说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过此视频了解如何构造请求调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme}
"access_point_name": "设备管理-北京一-1", "region_id": "cn-north-1" }, { "access_point_id": "DMP-CNNorth-4-1", "access_point_name": "设备管理-北京四-1"
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。
终端节点 区域名称 区域 终端节点(Endpoint) 端口 协议 华北-北京四 cn-north-4 iot-bs.cn-north-4.myhuaweicloud.com 5683 LWM2M 华北-北京四 cn-north-4 iot-bs.cn-north-4.myhuaweicloud
MQTT CONNECT连接鉴权 接口功能 设备发放平台设备侧支持MQTT协议的connect消息接口,接口规范参考MQTT标准规范,鉴权通过后建立设备与平台间的MQTT连接。 设备发放平台目前只支持MQTTS接入,设备通过connect消息接口和平台建立MQTT连接时,需要使用