1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
本接口(BatchUpdateFirmware)用于批量更新设备固件
默认接口请求频率限制:10000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:BatchUpdateFirmware。 |
Version | 是 | String | 公共参数,本接口取值:2020-12-15。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ProductID | 是 | String | 产品ID 示例值:abc |
FirmwareVersion | 是 | String | 固件新版本号 示例值:1-2-2 |
FirmwareOriVersion | 否 | String | 固件原版本号,根据文件列表升级固件不需要填写此参数 示例值:1-2-1 |
UpgradeMethod | 否 | Integer | 升级方式,0 静默升级 1 用户确认升级。 不填默认为静默升级方式 示例值:0 |
FileName | 否 | String | 设备列表文件名称,根据文件列表升级固件需要填写此参数 示例值:test |
FileMd5 | 否 | String | 设备列表的文件md5值 示例值:123123 |
FileSize | 否 | Integer | 设备列表的文件大小值 示例值:123 |
DeviceNames.N | 否 | Array of String | 需要升级的设备名称列表 示例值:["dsad","dsad"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | Integer | 任务ID 示例值:12312412 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 批量更新固件
输入示例
POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BatchUpdateFirmware
<公共请求参数>
{
"ProductID": "ABCDE12345",
"FirmwareVersion": "2.0.0",
"FirmwareOriVersion": "1.0.0"
}
输出示例
{
"Response": {
"TaskId": 123456,
"RequestId": "xxxxxxxxxxxxxxxxxxxxxxx"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DeviceIsUpdating | 设备正在升级中。 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound.FirmwareNotExist | 固件不存在。 |