帮你快速理解、总结文档立即下载
文档中心>物联网开发平台

查询固件升级任务列表

最近更新时间：2026-09-24 02:22:02
我的收藏

本页目录：

1. 接口描述

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

查询固件升级任务列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeFirmwareTask。
Version 是 String 公共参数，本接口取值：2019-04-23。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-guangzhou, ap-shanghai, ap-shanghai-fsi, eu-frankfurt, na-ashburn 。
ProductID 是 String

产品ID


示例值：J2CRPPZ8J4
FirmwareVersion 是 String

固件版本号


示例值：1.0.0
TaskId 是 Integer

固件任务ID


示例值：10000

3. 输出参数

参数名称 类型 描述
TaskId Integer

固件任务ID


示例值：1000175
Status Integer

固件任务状态


示例值：3
CreateTime Integer

固件任务创建时间，单位：秒


示例值：1589466879
Type Integer

固件任务升级类型


示例值：1
ProductName String

产品名称


示例值：门锁
UpgradeMode String

固件任务升级模式。originalVersion（按版本号升级）、filename（提交文件升级）、devicenames（按设备名称升级）


示例值：originalVersion
ProductId String

产品ID


示例值：J2CRPPZ8J4
OriginalVersion String

原始固件版本号，在UpgradeMode是originalVersion升级模式下会返回


示例值：v1.0
CreateUserId Integer

创建账号ID


示例值：89556966
CreatorNickName String

创建账号ID昵称


示例值：leo
DelayTime Integer

延迟时间


示例值：10
TimeoutInterval Integer

超时时间


示例值：10
UpgradeMethod Integer

静默升级or用户确认升级


示例值：0
MaxRetryNum Integer

最大重试次数


示例值：10
FwType String

固件类型


示例值：mcu
RetryInterval Integer

重试间隔时间单位min


示例值：1
OverrideMode Integer

是否覆盖任务


示例值：1
TaskUserDefine String

用户自定义消息


示例值：{"data": 1}
RateLimit Integer

每分钟发送设备量


示例值：1000
EndTime Integer

任务截止时间，Unix 时间戳（单位：秒）。传入 0 或不传表示不设截止，任务按原重试/超时策略执行完毕。

单位：秒


示例值：1791811200
StartTime Integer

任务开始调度时间，Unix 时间戳（单位：秒）。传入 0 或不传时任务立即创建执行，与 DelayTime 同时传入时，本参数优先生效。

单位：秒


示例值：1791206400
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

查询指定批量升级固件任务的详情

输入示例

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

{
    "ProductID": "product",
    "FirmwareVersion": "1.0.0",
    "TaskId": 1000
}

输出示例

{
    "Response": {
        "TaskId": 1000,
        "ProductId": "product",
        "ProductName": "name",
        "CreatorNickName": "leo",
        "Status": 5,
        "Type": 1,
        "CreateTime": 1791206390,
        "CreateUserId": 2362445,
        "UpgradeMode": "filename",
        "OriginalVersion": "1.0.0",
        "UpgradeMethod": 0,
        "DelayTime": 0,
        "TimeoutInterval": 86400,
        "MaxRetryNum": 3,
        "RetryInterval": 60,
        "OverrideMode": 0,
        "FwType": "mcu",
        "TaskUserDefine": "{\"key\":\"value\"}",
        "RateLimit": 1000,
        "StartTime": 1791206400,
        "EndTime": 1791811200,
        "RequestId": "3c11474f-9501-482f-8b59-97213b8779d4"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError.DBOperationError DB操作错误。
InternalError.InternalRPCError 内部RPC错误。
ResourceNotFound.FirmwareTaskNotExist 固件升级任务不存在。
ResourceNotFound.StudioProductNotExist 产品不存在。
中国站