1. 接口描述
接口请求域名： iotvideo.tencentcloudapi.com 。
本接口用于查询固件升级任务列表
默认接口请求频率限制：5000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeFirmwareTasks。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProductID | 是 | String | 产品ID 示例值：abc |
| FirmwareVersion | 是 | String | 固件版本号 示例值：1-2-1 |
| Offset | 是 | Integer | 查询偏移量 示例值：1 |
| Limit | 是 | Integer | 返回查询结果条数 示例值：10 |
| Filters.N | 否 | Array of SearchKeyword | 搜索过滤条件 示例值：[{"Key":"a","Value":"b"}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskInfos | Array of FirmwareTaskInfo | 固件升级任务列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Total | Integer | 固件升级任务总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询固件升级任务列表
输入示例
POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFirmwareTasks
<公共请求参数>
{
"ProductID": "ABCDE12345",
"FirmwareVersion": "1.0.0",
"Offset": 1,
"Limit": 5
}输出示例
{
"Response": {
"Total": 53,
"TaskInfos": [
{
"TaskId": 1000175,
"Status": 3,
"CreateTime": 1589466879,
"Type": 1
},
{
"TaskId": 1000176,
"Status": 3,
"CreateTime": 1589467049,
"Type": 1
},
{
"Status": 3,
"CreateTime": 1589467138,
"Type": 1,
"TaskId": 1000179
},
{
"TaskId": 1000180,
"Status": 3,
"CreateTime": 1589467139,
"Type": 1
},
{
"Type": 1,
"TaskId": 1000182,
"Status": 3,
"CreateTime": 1589467141
}
],
"RequestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |