1. 接口描述
接口请求域名： iotexplorer.tencentcloudapi.com 。
查询固件信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeFirmware。 |
| Version | 是 | String | 公共参数，本接口取值：2019-04-23。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProductID | 是 | String | 产品ID 示例值：I6KTCZ170U |
| FirmwareVersion | 是 | String | 固件版本号 示例值：t.2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Version | String | 固件版本号 示例值：t.2 |
| ProductId | String | 产品ID 示例值：I6KTCZ170U |
| Name | String | 固件名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：test |
| Description | String | 固件描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：ttttt |
| Md5sum | String | 固件Md5值 注意：此字段可能返回 null，表示取不到有效值。 示例值：1a5c386576074d22a604b795e8917e1a |
| Createtime | Integer | 固件上传的秒级时间戳 注意：此字段可能返回 null，表示取不到有效值。 示例值：1599626765 |
| ProductName | String | 产品名称 示例值：8bvsn6go_测试OTA升级 |
| FwType | String | 固件升级模块 注意：此字段可能返回 null，表示取不到有效值。 示例值：mcu |
| UserDefined | String | 固件用户自定义配置信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"key1":"value1", "key2":"支持中文"} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询固件信息
输入示例
POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFirmware
<公共请求参数>
{
"ProductID": "I6KTCZ170U",
"FirmwareVersion": "t.2"
}输出示例
{
"Response": {
"Createtime": 1599626765,
"Description": "ttttt",
"Md5sum": "1a5c386576074d22a604b795e8917e1a",
"Name": "test",
"ProductId": "I6KTCZ170U",
"ProductName": "8bvsn6go_测试OTA升级",
"RequestId": "01365e8c-f025-40b9-97a4-fa583d6c569e",
"Version": "t.2",
"FwType": "mcu"
}
}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.DBOpertaionError | DB操作错误。 |
| InternalError.InternalRPCError | 内部RPC错误。 |
| ResourceNotFound.FirmwareNotExist | 固件不存在。 |
| ResourceNotFound.ProductNotExist | 产品不存在。 |
| ResourceNotFound.StudioProductNotExist | 产品不存在。 |
| UnauthorizedOperation.NoPermissionToStudioProduct | 产品ACL错误。 |
| UnsupportedOperation.InstanceIsolated | 由于实例到期已被禁用，请续费后使用。 |
