华为云用户手册

  • URI PUT /v5/iot/{project_id}/routing-rule/backlog-policy/{policy_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 policy_id 是 String 参数说明:数据流转积压策略id,用于唯一标识一个数据流转积压策略,在创建数据流转积压策略时由 物联网平台 分配获得。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用 IAM 服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_name 否 String 参数说明:数据流转积压策略名称。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度:1 最大长度:256 description 否 String 参数说明:用户自定义的数据流转积压策略描述。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度:1 最大长度:256 backlog_size 否 Integer 参数说明:数据积压大小。单位为B(字节),取值范围为0~1073741823的整数,默认为1073741823(即1GB)。当backlog_size为0时,表示不积压。若同时配置了backlog_size和backlog_time两个维度,则以最先达到阈值的维度为准。 最小值:0 最大值:1073741823 缺省值:1073741823 backlog_time 否 Integer 参数说明:数据积压时间。单位为s(秒),取值范围为0~86399的整数,默认为86399(即1天)。当backlog_time为0时,表示不积压。若同时配置了backlog_size和backlog_time两个维度,则以最先达到阈值的维度为准。 最小值:0 最大值:86399 缺省值:86399
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 policy_id String 参数说明:数据流转积压策略id,用于唯一标识一个数据流转积压策略,在创建数据流转积压策略时由物联网平台分配获得。 policy_name String 参数说明:数据流转积压策略名称。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度:1 最大长度:256 description String 参数说明:用户自定义的数据流转积压策略描述。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合。 最小长度:1 最大长度:256 backlog_size Integer 参数说明:数据积压大小。单位为B(字节),取值范围为0~1073741823的整数,默认为1073741823(即1GB)。当backlog_size为0时,表示不积压。若同时配置了backlog_size和backlog_time两个维度,则以最先达到阈值的维度为准。 最小值:0 最大值:1073741823 缺省值:1073741823 backlog_time Integer 参数说明:数据积压时间。单位为s(秒),取值范围为0~86399的整数,默认为86399(即1天)。当backlog_time为0时,表示不积压。若同时配置了backlog_size和backlog_time两个维度,则以最先达到阈值的维度为准。 最小值:0 最大值:86399 缺省值:86399
  • 响应示例 状态码: 200 OK { "targets" : [ { "target" : "e495cf17-ff79-4294-8f64-4d367919d665", "status" : "failure", "error_code" : "IOTDA.014219", "error_msg" : "Invalid input. The target is not in the task" }, { "target" : "e495cf17-ff79-4294-8f64-4d367919d677", "status" : "success" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 最小长度:1 最大长度:36 表3 请求Body参数 参数 是否必选 参数类型 描述 targets 否 Array of strings 执行批量任务的目标集合,最多支持100个目标,当task_type为firmwareUpgrade,softwareUpgrade时,此处填写device_id
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 targets Array of BatchTargetResult objects 批量操作目标结果集合 表5 BatchTargetResult 参数 参数类型 描述 target String 执行批量任务的目标。 status String 目标的执行结果,为success或failure error_code String 操作失败的错误码 error_msg String 操作失败的错误描述
  • 请求示例 停止所有正在执行中,等待中和失败待重试状态的子任务。 POST https://{endpoint}/v5/iot/{project_id}/batchtasks/{task_id}/stop { } 停止执行指定目标集合的子任务 POST https://{endpoint}/v5/iot/{project_id}/batchtasks/{task_id}/stop { "targets" : [ "e495cf17-ff79-4294-8f64-4d367919d665" ] }
  • URI POST /v5/iot/{project_id}/batchtasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数说明:批量任务ID,创建批量任务时由物联网平台分配获得。 取值范围:长度不超过24,只允许小写字母a到f、数字的组合。 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。
  • URI GET /v5/iot/{project_id}/routing-rule/actions/{action_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 action_id 是 String 参数说明:规则动作ID。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。
  • 响应示例 状态码: 200 OK { "action_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce0", "rule_id" : "1a7ffc5c-d89c-44dd-8265-b1653d951ce1", "app_id" : "1a7ffc5cd89c44dd8265b1653d951ce0", "channel" : "HTTP_FORWARDING", "channel_detail" : { "http_forwarding" : { "url" : "http://host:port/callbackurltest" } } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID。
  • AT+HMSUB 该指令用于订阅自定义主题。 指令 参数 参数缺省处理 AT响应结果 使用示例 AT+HMSUB=qos, topic qos:topic的qos 默认值:0 +HMSUB OK when success AT+HMSUB=0,"$oc/devices/my_deviceid/user/my_subtopic" topic:自定义主题 自定义 +HMSUB ERR:code code:reference to en_oc_mqtt_err_code_t defines 父主题: 模组AT指令参考
  • 设备鉴权 API 说明 设备鉴权 设备鉴权接口,鉴权通过后建立设备与平台间才能处理业务连接。鉴权成功后平台返回access_token。调用属性上报、消息上报等其他接口时,都需要携带access_token信息。如果access_token超期,需要重新认证设备获取access_token。如果access_token未超期重复获取access_token,老的access_token在未超期前保留30s,30s之后失效。
  • 响应示例 状态码: 200 OK { "rule_id" : "5bcaddda-75bf-4623-8c8d-26175c41fcca", "rule_name" : "rulename", "description" : "description", "subject" : { "resource" : "device", "event" : "create" }, "app_type" : "GLOBAL", "app_id" : "1a7ffc5cd89c44dd8265b1653d951ce0", "select" : "*", "where" : "product_id='d89c-44dd-8265-b1653d951ce0'", "active" : false }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 rule_id String 规则触发条件ID,用于唯一标识一个规则触发条件,在创建规则条件时由物联网平台分配获得。 rule_name String 用户自定义的规则名称。 最小长度:1 最大长度:256 description String 用户自定义的规则描述。 最小长度:1 最大长度:256 subject RoutingRuleSubject object 资源事件信息,即资源变化事件。 app_type String 租户规则的生效范围,取值如下: GLOBAL:生效范围为租户级 APP:生效范围为资源空间级。 app_id String 资源空间ID select String 用户自定义sql select语句,最大长度2500,该参数仅供标准版和企业版用户使用。 最小长度:0 最大长度:2500 where String 用户自定义sql where语句,最大长度2500,该参数仅供标准版和企业版用户使用。 最小长度:0 最大长度:2500 active Boolean 规则条件的状态是否为激活。 表5 RoutingRuleSubject 参数 参数类型 描述 resource String 参数说明:资源名称。 取值范围: device:设备。 device.property:设备属性。 device.message:设备消息。 device.message.status:设备消息状态。 device.status:设备状态。 batchtask:批量任务。 product:产品。 device.command.status:设备异步命令状态。 最小长度:1 最大长度:50 event String 参数说明:资源事件。 取值范围:与资源有关,不同的资源,事件不同。event需要与resource关联使用,具体的“resource:event”映射关系如下: device:create(设备添加) device:delete(设备删除) device:update(设备更新) device.status:update (设备状态变更) device.property:report(设备属性上报) device.message:report(设备消息上报) device.message.status:update(设备消息状态变更) batchtask:update (批量任务状态变更) product:create(产品添加) product:delete(产品删除) product:update(产品更新) device.command.status:update(设备异步命令状态更新) 最小长度:1 最大长度:50
  • 请求示例 修改指定规则触发条件,指定条件为产品为d89c-44dd-8265-b1653d951ce0。 PUT https://{endpoint}/v5/iot/{project_id}/routing-rule/rules/{rule_id} { "rule_name" : "rulename", "description" : "description", "select" : "*", "where" : "product_id='d89c-44dd-8265-b1653d951ce0'", "active" : true }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,一般华为云租户无需携带该参数,仅在物理多租场景下从管理面访问API时需要携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 rule_name 否 String 参数说明:规则名称。 取值范围:长度不超过256,只允许中文、字母、数字、以及_?'#().,&%@!-等字符的组合 最小长度:1 最大长度:256 description 否 String 参数说明:用户自定义的规则描述。 最小长度:0 最大长度:256 select 否 String 参数说明:用户自定义sql select语句,最大长度2500,更新sql时,select跟where必须同时传参,如果需要清除该参数的值,输入空字符串,该参数仅供标准版和企业版用户使用。 最小长度:0 最大长度:2500 where 否 String 参数说明:用户自定义sql where语句,最大长度2500,更新操作时,select跟where必须同时传参,如果需要清除该参数的值,输入空字符串,该参数仅供标准版和企业版用户使用。 最小长度:0 最大长度:2500 active 否 Boolean 参数说明:修改规则条件的状态是否为激活。
  • 示例 假设设备上报数据内容为"hello!",请求的样例参考如下: 仅发送消息内容: Topic: $oc/devices/{device_id}/sys/messages/up 数据格式: hello! 以系统格式进行上报: Topic: $oc/devices/{device_id}/sys/messages/up 数据格式: { "object_device_id": "{object_device_id}", "name":null, "id":"aca6a906-c74c-4302-a2ce-b17ba2ce630c", "content":"hello!" }
  • Topic 上行:$oc/devices/{device_id}/sys/messages/up 消息上报时除了使用系统预置的消息上报topic外,设备也可以使用非平台声明的自定义topic。如$oc/devices/{device_id}/user/{自定义}。 数据上报的过程中,可以通过在topic后面携带?request_id来指定request_id。比如说消息上报:$oc/devices/{device_id}/sys/messages/up?request_id={request_id}。若不指定,平台会自动生成request_id,用于标识此次请求。
  • 功能描述 是指设备无法按照产品模型中定义的属性格式进行数据上报时,可调用此接口将设备的自定义数据格式上报给平台,平台对该消息不进行解析,该消息可以转发给应用服务器或华为云其他云服务上进行存储和处理。 消息上报和属性上报的区别,请查看消息通信说明。 低配置且资源受限或者对网络流量有要求的设备,不适合直接构造JSON数据与物联网平台通信时,可将原始二进制数据透传到物联网平台。通过开发编解码插件实现二进制数据到平台定义JSON格式的转换。
  • 参数说明 消息上报对数据内容不做固定的要求,当使用系统格式进行下发时,参数说明如下: 字段名 必选/可选 类型 参数描述 object_device_id 可选 String 网关设备上报时,子设备进行上报需填写该参数。object_device_id为Topic中设备的子设备Id,否则将请求失败。 直连设备上报时,object_device_id需与Topic中的device_id一致。 若为空则默认该参数与Topic中的device_id一致。 name 可选 String 消息名称,可不填写,做说明用。 id 可选 String 消息的唯一标识,用于区分与查找消息。如不填写系统会自动生成一个消息ID,消息ID不可重复。 content 必选 Object、String 消息内容,可以为base64编码格式。 设备消息上报时平台不会校验消息格式,这里的参数说明和示例为给的消息样例,设备可以根据需要进行自定义数据格式的上报。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 最小长度:1 最大长度:36
  • URI GET /v5/iot/{project_id}/batchtasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 表2 Query参数 参数 是否必选 参数类型 描述 app_id 否 String 参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,可以携带该参数查询指定资源空间下的任务列表,不携带该参数则会查询该用户下所有任务列表。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。 task_type 是 String 参数说明:批量任务类型。 取值范围: softwareUpgrade: 软件升级任务 firmwareUpgrade: 固件升级任务 createDevices: 批量创建设备任务 deleteDevices: 批量删除设备任务 freezeDevices: 批量冻结设备任务 unfreezeDevices: 批量解冻设备任务 createCommands: 批量创建同步命令任务 createAsyncCommands: 批量创建异步命令任务 createMessages: 批量创建消息任务 updateDeviceShadows:批量配置设备影子任务 updateDevices:批量更新设备任务 status 否 String 参数说明:批量任务的状态,可选参数。 取值范围: Initializing: 初始化中。 Waitting: 等待中。 Processing: 执行中。 Success: 成功。 Fail: 失败。 PartialSuccess: 部分成功。 Stopped: 停止。 Stopping: 停止中。 limit 否 Integer 参数说明:分页查询时每页显示的记录数。 取值范围:1-50的整数,默认值为10。 最小值:1 最大值:50 缺省值:10 marker 否 String 参数说明:上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的数据记录ID也会越大。若填写marker,则本次只查询记录ID小于marker的数据记录。若不填写,则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据,则每次查询时必须填写上一次查询响应中的marker值。 取值范围:长度为24的十六进制字符串,默认值为ffffffffffffffffffffffff。 缺省值:ffffffffffffffffffffffff offset 否 Integer 参数说明:表示从marker后偏移offset条记录开始查询。默认为0,取值范围为0-500的整数。当offset为0时,表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑,您可以搭配marker使用该参数实现翻页,例如每页50条记录,1-11页内都可以直接使用offset跳转到指定页,但到11页后,由于offset限制为500,您需要使用第11页返回的marker作为下次查询的marker,以实现翻页到12-22页。 取值范围:0-500的整数,默认为0。 最小值:0 最大值:500 缺省值:0
  • 响应示例 状态码: 200 OK { "batchtasks" : [ { "task_id" : "5c8ba99030344005c02316ad", "task_name" : "testname", "task_type" : "softwareUpgrade", "targets" : [ "e495cf17-ff79-4294-8f64-4d367919d665" ], "targets_filter" : { "group_ids" : [ "e495cf17-ff79-4294-8f64-4d367919d665" ] }, "document" : { "package_id" : "32822e5744a45ede319d2c50" }, "task_policy" : { "schedule_time" : "20151212T121212Z", "retry_count" : 5, "retry_interval" : 60 }, "status" : "Success", "status_desc" : "string", "task_progress" : { "total" : 0, "processing" : 0, "success" : 0, "fail" : 0, "waitting" : 0, "fail_wait_retry" : 0, "stopped" : 0 }, "create_time" : "20151212T121212Z" } ], "page" : { "count" : 10, "marker" : "5c90fa7d3c4e4405e8525079" } }
  • AT+HMPUB 该指令用于发送MQTT数据到指定TOPIC。 指令 参数 参数缺省处理 AT响应结果 使用示例 AT+HMPUB=qos,topic,payload_len,payload qos:mqtt的qos(0,1,2) 默认值:0 +HMPUB OK(发布成功) hexstring模式下,发送数据的byte流必须转换为ascii码的hexstring。 如发送字节0x12 0x34两字节到"test":AT+HMPUB=0,"test",2,1234 topic:指定的topic 默认为上报属性的topic,建议填写 +HMPUB ERR:code (发布失败,code表示失败原因) len:待发送数据长度,单位为字节 - - payload:转换为ascii码的数据,最大长度1024字节 最大支持长度2KB - 父主题: 模组AT指令参考
  • 基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) 一个AZ是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 华为云的区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 资源空间 指在物联网平台中为您的业务划分的一个资源空间,您在平台中创建的资源(如产品、设备等)都需要归属到某个资源空间,您可以基于资源空间实现多业务应用的分域管理。详情请参见资源空间。 产品 产品模型用于描述设备具备的能力和特性。开发者通过定义产品模型,在物联网平台构建一款设备的抽象模型。详情请参见什么是产品模型。 消息下发 消息下发不依赖产品模型,提供给设备的单向通知,具有消息缓存功能;详情请参见消息下发概述。 命令下发 为能有效地对设备进行管理,设备的产品模型中定义了物联网平台可向设备下发的命令,应用服务器可以调用物联网平台应用侧API接口向设备下发命令,以实现对设备的远程控制。详情请参见命令下发概述。 属性下发 属性下发分为查询设备属性和修改属性参数两种,查询设备属性用于应用侧或平台主动获取设备属性数据,修改属性参数用于应用侧或平台设置设备属性值并同步到设备侧。详情请参见属性下发概述。 AMQP队列管理 AMQP(Advanced Message Queuing Protocol)即高级队列消息协议。用户可通过AMQP的客户端与IoT平台建立链接,来接收平台推送数据。详情请参见AMQP订阅推送。 数据流转 设备接入到物联网平台后,便可与物联网平台进行通信。设备通过自定义Topic或产品模型方式将数据上报到平台,在控制台设置后,通过订阅推送的方式,将设备生命周期变更、设备属性上报、设备消息上报、设备消息状态变更、设备状态变更、批量任务状态变更等消息推送到您指定的服务器。详情请参见订阅推送方式概述。 设备影子 物联网平台支持创建设备的“影子”。设备影子是一个JSON文件,用于存储设备的在线状态、设备最近一次上报的设备属性值、应用服务器期望下发的配置。每个设备有且只有一个设备影子,设备可以获取和设置设备影子以此来同步设备属性值,这个同步可以是影子同步给设备,也可以是设备同步给影子。详情请参见设备影子。 设备组(群组) 群组是一系列设备的集合,用户可以对资源空间下所有设备,根据区域、类型等不同规则进行分类建立群组,以便处理对海量设备的批量操作。例如,对资源空间下所有水表设备的群组进行固件升级。平台支持群组的增删改查操作,支持给群组绑定和解绑设备,支持一个设备被添加到多个群组中。详情请参见群组。 标签 对于拥有大量云资源的用户,可以通过给云资源打标签,快速查找具有某标签的云资源,可对这些资源标签统一进行检视、修改、删除等操作,方便用户对云资源的管理。详情请参见标签概述。 联动规则 联动规则分为端侧规则和云端规则。端侧规则:在云端规则中,用户创建的规则的解析及执行均在云端完成,云平台需要判断条件是否满足并触发相应的设备联动操作。详情请参见端侧规则。云端规则:当用户设置云端规则时,物联网平台会判断是否满足规则触发条件,在条件满足时,平台会执行用户预设的动作。比如:事件告警、主题通知、设备命令下发等。详情请参见云端规则。 批量任务 当需要对多个设备进行批量操作时,可以选择批量任务执行该操作。当前支持批量软固件升级、批量创建设备、批量修改设备、批量删除设备、批量冻结设备、批量解冻设备、批量创建命令、批量创建消息、批量配置设备影子和批量更新设备任务。 OTA升级 OTA升级指的是软固件升级,软件升级指升级设备的系统软件和应用软件,固件升级指升级设备硬件的底层“驱动程序”。升级方式均为将软/固件包上传到物联网平台或者关联用户OBS上的对象,设备从物联网平台或用户OBS获取软/固件包实现远程升级。详情请参见OTA升级相关问题。 父主题: 使用前必读
  • URI DELETE /v5/iot/{project_id}/products/{product_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 product_id 是 String 参数说明:产品ID,用于唯一标识一个产品,在物联网平台创建产品后由平台分配获得。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。 表2 Query参数 参数 是否必选 参数类型 描述 app_id 否 String 参数说明:资源空间ID。此参数为非必选参数,存在多资源空间的用户需要使用该接口时,建议携带该参数,指定要删除的产品属于哪个资源空间;若不携带,则优先删除默认资源空间下产品,如默认资源空间下无对应产品,则按照产品创建时间删除最早创建产品。如果用户存在多资源空间,同时又不想携带该参数,可以联系华为技术支持对用户数据做资源空间合并。 取值范围:长度不超过36,只允许字母、数字、下划线(_)、连接符(-)的组合。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。
  • URI POST /v5/iot/{project_id}/devices/{device_id}/unfreeze 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 device_id 是 String 参数说明:设备ID,用于唯一标识一个设备。在注册设备时直接指定,或者由物联网平台分配获得。 取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。
共100000条