物联网开发平台查询设备固件升级状态-固件升级相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（DescribeFirmwareUpdateStatus）用于查询设备固件升级状态及进度。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
OriVersion	String	升级任务源版本。注意：此字段可能返回 null，表示取不到有效值。
DstVersion	String	升级任务目标版本。注意：此字段可能返回 null，表示取不到有效值。
Status	Integer	升级状态：- 0：设备离线。- 1：待处理。- 2：消息下发成功。- 3：下载中。- 4：烧录中。- 5：失败。- 6：升级完成。- 7：正在处理中。- 8：等待用户确认。- 10：升级超时。- 20：下载完成。
Percent	Integer	进度注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功示例

输入示例

https://iotexplorer.tencentcloudapi.com/?Action=DescribeFirmwareUpdateStatus
&ProductId=PR******ID
&DeviceName=de***01
&<公共请求参数>

输出示例

{
    "Response": {
        "DstVersion": "1.0",
        "OriVersion": "1.4",
        "Percent": 100,
        "RequestId": "adcfghb",
        "Status": 6
    }
}

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. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.NoPermission	无权限。
UnauthorizedOperation.NoPermissionToStudioProduct	产品ACL错误。
UnauthorizedOperation.PermissionDenied	没有权限。