物联网智能视频服务（消费版）查询固件升级任务详情-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： iotvideo.tencentcloudapi.com 。

此接口查询固件升级任务详情

默认接口请求频率限制：10000次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeFirmwareTask。
Version	是	String	公共参数，本接口取值：2020-12-15。
Region	否	String	公共参数，本接口不需要传递此参数。
ProductID	是	String	产品ID 示例值：aaa
FirmwareVersion	是	String	固件版本号示例值：1-2-1
TaskId	是	Integer	固件任务ID 示例值：test

3. 输出参数

参数名称	类型	描述
TaskId	Integer	固件任务ID 注意：此字段可能返回 null，表示取不到有效值。示例值：test
Status	Integer	固件任务状态注意：此字段可能返回 null，表示取不到有效值。示例值：1
CreateTime	Integer	固件任务创建时间，单位:秒注意：此字段可能返回 null，表示取不到有效值。示例值：123456
Type	Integer	固件任务升级类型注意：此字段可能返回 null，表示取不到有效值。示例值：1
ProductName	String	产品名称注意：此字段可能返回 null，表示取不到有效值。示例值：abc
UpgradeMode	String	固件任务升级模式。originalVersion（按版本号升级）、filename（提交文件升级）、devicenames（按设备名称升级）注意：此字段可能返回 null，表示取不到有效值。示例值：test
ProductId	String	产品ID 注意：此字段可能返回 null，表示取不到有效值。示例值：abc
OriginalVersion	String	原始固件版本号，在UpgradeMode是originalVersion升级模式下会返回注意：此字段可能返回 null，表示取不到有效值。示例值：1-2-1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询固件升级任务详情

输入示例

POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFirmwareTask
<公共请求参数>

{
    "ProductID": "ABCDE12345",
    "FirmwareVersion": "1.0.0",
    "TaskId": 10000
}

输出示例

{
    "Response": {
        "TaskId": 1000175,
        "Status": 3,
        "CreateTime": 1589466879,
        "Type": 1,
        "ProductName": "门锁",
        "OriginalVersion": "xx",
        "UpgradeMode": "originalVersion",
        "ProductId": "ABCDE12345",
        "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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
ResourceNotFound.FirmwareTaskNotExist	固件升级任务不存在。

查询固件升级任务详情

本页目录：