1. 接口描述
接口请求域名: iotexplorer.tencentcloudapi.com 。
本接口(BatchUpdateFirmware)用于批量更新设备固件
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:BatchUpdateFirmware。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProductID | 是 | String | 产品ID 示例值:hsdkhfueh |
FirmwareVersion | 是 | String | 固件新版本号 示例值:2.0.0 |
FirmwareOriVersion | 否 | String | 固件原版本号 示例值:1.0.0 |
UpgradeMethod | 否 | Integer | 升级方式,0 静默升级 1 用户确认升级。 不填默认为静默升级方式 示例值:0 |
FileName | 否 | String | 设备列表文件名称,根据文件列表升级固件需要填写此参数 示例值:ota |
FileMd5 | 否 | String | 设备列表的文件md5值 示例值:608afe29a06b19d3033c5f8787ec75fa |
FileSize | 否 | Integer | 设备列表的文件大小值 示例值:120 |
DeviceNames.N | 否 | Array of String | 需要升级的设备名称列表 示例值:["dev001"] |
TimeoutInterval | 否 | Integer | 固件升级任务,默认超时时间。 最小取值120秒,最大为900秒 示例值:120 |
Type | 否 | Integer | 固件升级任务类型,默认静态升级值为空或1,动态升级值为7 示例值:7 |
DelayTime | 否 | Integer | 任务延迟时间 示例值:10 |
OverrideMode | 否 | Integer | 是否覆盖,0不覆盖,1覆盖 示例值:1 |
MaxRetryNum | 否 | Integer | 失败重试次数 示例值:1 |
RetryInterval | 否 | Integer | 重试间隔min 示例值:1 |
FwType | 否 | String | 固件模块 示例值:mcu |
TaskUserDefine | 否 | String | 用户自定义信息 示例值:{"key":"value"} |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | Integer | 任务Id 示例值:1000696 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
https://iotexplorer.tencentcloudapi.com/?Action=BatchUpdateFirmware
&ProductID=sdfewihf
&FirmwareVersion=2.0.0
&FirmwareOriVersion=1.0.0
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "xxxxxxxxxxxxxxxxxxxxx",
"TaskId": 1000696
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DeviceIsUpdating | 设备正在升级中。 |
InternalError | 内部错误。 |
InternalError.DBOpertaionError | DB操作错误。 |
InternalError.InternalRPCError | 内部RPC错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound.FirmwareNotExist | 固件不存在。 |
ResourceNotFound.StudioProductNotExist | 产品不存在。 |
UnauthorizedOperation.NoPermissionToStudioProduct | 产品ACL错误。 |
UnsupportedOperation.InstanceIsolated | 由于实例到期已被禁用,请续费后使用。 |