1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
本接口(ListFirmwares)用于获取固件列表
默认接口请求频率限制:5000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListFirmwares。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
PageNum | 是 | Integer | 获取的页数 示例值:1 |
PageSize | 是 | Integer | 分页的大小 示例值:10 |
ProductID | 否 | String | 产品ID 示例值:abc |
Filters.N | 否 | Array of SearchKeyword | 搜索过滤条件 示例值:[{"Key":"test","Value":"b"}] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 固件总数 示例值:10 |
Firmwares | Array of FirmwareInfo | 固件列表 示例值:test |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取固件列表
输入示例
POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListFirmwares
<公共请求参数>
{
"ProductID": "ABCDE12345",
"PageNum": 1,
"PageSize": 10
}
输出示例
{
"Response": {
"TotalCount": 1,
"Firmwares": [
{
"Name": "xx",
"ProductName": "xx",
"ProductId": "xx",
"Description": "xx",
"Version": "1.0.0",
"Md5sum": "ahbdjshfuisdfoisjfos",
"CreateTime": "147873872173"
}
],
"RequestId": "xxxxxxxxxxxxxxxxxxxxxxx"
}
}
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 | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceNotFound | 资源不存在。 |