检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 接入点管理 设备CA证书管理 设备管理 产品管理 注册组管理 发放策略管理
如何调用API 构造请求 认证鉴权 返回结果
API列表 通过使用设备发放提供的接口,您可以完整的使用设备发放的所有功能。 接入点管理 API 说明 查询接入点列表 查询当前用户可用的接入点列表,包括设备接入企业版实例。 查询接入点详情 查询接入点接入信息。 查询接入点下的应用 查询接入点下的应用。 证书管理 API 说明 上传设备CA证书
删除设备 功能介绍 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。若设备已发放成功,此接口将级联删除设备接入实例中的该设备。 URI DELETE /v5/iotps/{project_id}/devices/{device_id}
File CA证书(设备CA证书/客户端CA证书) server.crt - 双向认证,即双向证书认证,与单向认证中不同的是,不仅包含单向认证中的设备对平台的证书验证步骤,还包含了平台对设备的证书验证步骤。
分页查询时每页显示的记录数,默认值为10,取值范围为1-50的整数。 最小值:1 最大值:50 缺省值:10 marker 否 String 上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的
查询接入点下的应用 功能介绍 查询接入点下的应用。 URI GET /v5/iotps/{project_id}/access-points/{access_point_id}/applications 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于查询接入点列表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”等。 对于查询接入点列表接口,平台会返回“
构造请求 本节介绍如何构造REST API的请求,并以调用IAM服务的获取用户Token为例说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过此视频了解如何构造请求调用API。 请求URI 请求URI由如下部分组成。 {URI-scheme}
device_cert_validity Integer 生成设备证书的有效期。CA证书选择云证书管理服务的CA证书可填写该字段。 最小值:1 最大值:10 device_cert_id String 设备证书id,设备采用云证书管理服务的CA注册,云证书管理服务生成的设备证书的唯一实例ID secure_access
data_type String 设备属性的数据类型。 enum_list Array of strings 设备属性的枚举值列表。 数组长度:0 - 1000 min String 设备属性的最小值。 最小长度:1 最大长度:16 max String 设备属性的最大值。 最小长度:1 最大长度:16
device_cert_validity Integer 生成设备证书的有效期。CA证书选择云证书管理服务的CA证书可填写该字段。 最小值:1 最大值:10 device_cert_id String 设备证书id,设备采用云证书管理服务的CA注册,云证书管理服务生成的设备证书的唯一实例ID secure_access
分页查询时每页显示的记录数,默认值为10,取值范围为1-50的整数。 最小值:1 最大值:50 缺省值:10 marker 否 String 上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的
删除设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台删除设备的CA证书 URI DELETE /v5/iotps/{project_id}/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是
上传设备CA证书 功能介绍 应用服务器可调用此接口在物联网平台上传设备的CA证书 URI POST /v5/iotps/{project_id}/certificates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 最小长度:1
String 证书id。使用第三方上传CA,证书ID为设备发放服务生成的证书id,使用云证书CA,证书ID为云证书服务生成的证书ID。 最小长度:0 最大长度:256 func_urn 否 String 函数的URN(Uniform Resource Name),唯一标识函数。 最小长度:1
参数说明:设备指纹。设置改字段时平台将设备指纹重置为指定值;不携带时将之置空,后续设备第一次接入时,该设备指纹的值将设置为第一次接入时的证书指纹。 取值范围:长度为40的十六进制字符串或者长度为64的十六进制字符串。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 device_id
Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 T
分页查询时每页显示的记录数,默认值为10,取值范围为1-50的整数。 最小值:1 最大值:50 缺省值:10 marker 否 String 上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的
String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 对证书执行的操作,当前支持generateCode:生成CA证书验证码,verify:校验证书