有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

本接口(DescribeFirmware)用于查询固件信息

默认接口请求频率限制:5000次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeFirmware。
Version String 公共参数,本接口取值:2021-11-25。
Region String 公共参数,详见产品支持的 地域列表
ProductID String 产品ID
示例值:abc
FirmwareVersion String 固件版本号
示例值:1-2-1

3. 输出参数

参数名称 类型 描述
Version String 固件版本号
示例值:1-2-3
ProductId String 产品ID
示例值:abc
Name String 固件名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
Description String 固件描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:testdes
Md5sum String 固件Md5值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1234dasdaw
Createtime Integer 固件上传的秒级时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1234567
ProductName String 产品名称
示例值:abcdefg
FwType String 固件升级模块
注意:此字段可能返回 null,表示取不到有效值。
示例值:mcu
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询固件信息

输入示例

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

{
    "ProductID": "7ZISKXPJVU",
    "FirmwareVersion": "1.0.3"
}

输出示例

{
    "Response": {
        "Description": "desc",
        "Md5sum": "md5",
        "Createtime": 1597047368,
        "RequestId": "xxxxxxxxxx",
        "Version": "1.0.3",
        "ProductId": "7ZISKXPJVU",
        "Name": "name",
        "ProductName": "ABC",
        "FwType": "mcu"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
ResourceNotFound 资源不存在。
ResourceNotFound.FirmwareNotExist 固件不存在。