检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 接入点管理 设备CA证书管理 设备管理 产品管理 注册组管理 发放策略管理
应用服务器可调用此接口在物联网平台上传设备的CA证书。 获取设备CA证书列表 应用服务器可调用此接口在物联网平台获取设备的CA证书列表。 删除设备CA证书 应用服务器可调用此接口在物联网平台删除设备的CA证书。 查询单个设备CA证书 应用服务器可调用此接口在物联网平台查询设备的CA证书。
如何调用API 构造请求 认证鉴权 返回结果
cloud CA Certificates exceptions" } 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 IoTDP.100001 The resource size exceed
使用前必读 概述 物联网平台把自身丰富的管理能力通过API的形式对外开放,包括接入点管理、证书管理、设备管理、 产品管理、注册组管理、策略管理等,帮助用户快速构筑基于物联网平台的行业应用。您可以根据本文档提供的API来使用物联网平台的服务,平台支持的全部API请参见API列表。 调用说明
设备安全认证 设备接入设备发放和接入平台之前,需要通过身份认证。当前,物联网平台支持密钥认证和X.509证书认证两种认证方式进行设备身份认证。 密钥认证 创建设备时,认证方式选择密钥认证,用户为设备指定或者平台自动生成设备密钥。设备接入平台时,携带密钥(为避免密钥在通信链路中直接
指设备是否通过安全协议方式接入,默认值为true。 true:通过安全协议方式接入。 false:通过非安全协议方式接入。 缺省值:true timeout 否 Integer 设备验证码的有效时间,单位:秒,默认值:0 若设备在有效时间内未接入物联网平台并激活,则平台会删除该设备的注
删除设备 功能介绍 应用服务器可调用此接口在物联网平台上删除指定设备。若设备下连接了非直连设备,则必须把设备下的非直连设备都删除后,才能删除该设备。若设备已发放成功,此接口将级联删除设备接入实例中的该设备。 URI DELETE /v5/iotps/{project_id}/devices/{device_id}
指设备是否通过安全协议方式接入,默认值为true。 true:通过安全协议方式接入。 false:通过非安全协议方式接入。 缺省值:true timeout Integer 设备验证码的有效时间,单位:秒,默认值:0 若设备在有效时间内未接入物联网平台并激活,则平台会删除该设备的注册
指设备是否通过安全协议方式接入,默认值为true。 true:通过安全协议方式接入。 false:通过非安全协议方式接入。 缺省值:true timeout 否 Integer 设备验证码的有效时间,单位:秒,默认值:0 若设备在有效时间内未接入物联网平台并激活,则平台会删除该设备的注
最大值:50 缺省值:10 marker 否 String 上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的数据记录ID也会越大。若填写marker,则本次只查询记录ID小于marke
指设备是否通过安全协议方式接入,默认值为true。 true:通过安全协议方式接入。 false:通过非安全协议方式接入。 缺省值:true timeout Integer 设备验证码的有效时间,单位:秒,默认值:0 若设备在有效时间内未接入物联网平台并激活,则平台会删除该设备的注册
自定义策略结构体 表10 TenantDomainResp 参数 参数类型 描述 domain_id String 公有云账户ID domain_name String 公有云账户名 最小长度:1 最大长度:64 表11 AccessPointResp 参数 参数类型 描述 access_point_id
删除注册组 功能介绍 应用服务器可调用此接口在物联网平台上删除指定注册组。 URI DELETE /v5/iotps/{project_id}/registration-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。
态,完整的状态码列表请参见状态码。 对于查询接入点列表接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”等。 对于查询接入点列表接口,平台会返回“Content-type”、Date等消息头。 响应消息体
自定义策略结构体 表4 TenantDomainResp 参数 参数类型 描述 domain_id String 公有云账户ID domain_name String 公有云账户名 最小长度:1 最大长度:64 表5 AccessPointResp 参数 参数类型 描述 access_point_id
删除注册组 功能介绍 应用服务器可调用此接口在物联网平台上删除指定注册组。 URI DELETE /v5/iotps/{project_id}/registration-groups/{registration_group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 product_id String 产品ID,用于唯一标识一个产品模型,在物联网平台的SP Portal上导入产品模型后由平台分配获得。
创建注册组 功能介绍 应用服务器可调用此接口在物联网平台创建一个注册组。 URI POST /v5/iotps/{project_id}/registration-groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 最小长度:1
修改注册组 功能介绍 应用服务器可调用此接口修改物联网平台中指定注册组的基本信息。 URI PUT /v5/iotps/{project_id}/registration-groups/{registration_group_id} 表1 路径参数 参数 是否必选 参数类型 描述