检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 接入点管理 设备CA证书管理 设备管理 产品管理 注册组管理 发放策略管理
如何调用API 构造请求 认证鉴权 返回结果
API列表 通过使用设备发放提供的接口,您可以完整的使用设备发放的所有功能。 接入点管理 API 说明 查询接入点列表 查询当前用户可用的接入点列表,包括设备接入企业版实例。 查询接入点详情 查询接入点接入信息。 查询接入点下的应用 查询接入点下的应用。 证书管理 API 说明 上传设备CA证书
接口说明 MQTT CONNECT连接鉴权 设备请求引导消息 设备接收引导信息
删除设备 功能介绍 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。若设备已发放成功,此接口将级联删除设备接入实例中的该设备。 URI DELETE /v5/iotps/{project_id}/devices/{device_id}
构造请求 本节介绍如何构造REST API的请求,并以调用IAM服务的获取用户Token为例说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过此视频了解如何构造请求调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme}
鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:0 最大长度:65535 响应参数 状态码: 200 表4 响应Body参数
注册设备 功能介绍 应用服务器可调用此接口在物联网平台注册一个设备,仅在注册后设备才可以接入物联网平台。 URI POST /v5/iotps/{project_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。
产品管理 查询产品列表 查询产品 父主题: API
设备管理 注册设备 查询设备列表 查询设备 修改设备 删除设备 操作设备 重置设备指纹 发放设备 父主题: API
发放策略管理 查询发放策略列表 创建发放策略 查询单个发放策略实例 删除发放策略实例 父主题: API
的状态,完整的状态码列表请参见状态码。 对于查询接入点列表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”等。 对于查询接入点列表接口,平台会返回“Content-type”、Date等消息头。
上传设备CA证书 获取设备CA证书列表 删除设备CA证书 查询单个设备CA证书 更新单个设备CA证书 生成CA证书验证码/验证设备CA证书 父主题: API
注册组管理 查询注册组列表 创建注册组 删除注册组 查询注册组详情 删除注册组 修改注册组 查询注册组下的设备 父主题: API
接入点管理 查询接入点列表 查询接入点详情 查询接入点下的应用 父主题: API
区域ID,用于区分不同的区域。 app_id 否 String 应用ID。此参数为非必选参数,用于兼容平台老用户存在多应用的场景。存在多应用的用户需要使用该接口时,可以携带该参数查询指定应用下的设备列表,不携带该参数则会查询该用户下所有设备列表。 最小长度:1 最大长度:256 响应参数 状态码: 200
查询设备 功能介绍 应用服务器可调用此接口查询物联网平台中指定设备的详细信息。 URI GET /v5/iotps/{project_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。
修改设备 功能介绍 应用服务器可调用此接口修改物联网平台中指定设备的基本信息。 URI PUT /v5/iotps/{project_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 对设备执行的操作,当前仅支持: resetDeviceSecret:重置秘钥。应用服务器可调用此接口重置设备秘钥,携