1. 接口描述
接口请求域名： iotvideo.tencentcloudapi.com 。
获取设备列表
默认接口请求频率限制：5000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDevices。 |
| Version | 是 | String | 公共参数，本接口取值：2021-11-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ProductId | 是 | String | 需要查看设备列表的产品 ID 示例值：PTROMP3AOB |
| Offset | 是 | Integer | 偏移量，Offset从0开始 示例值：0 |
| Limit | 是 | Integer | 分页的大小，最大100 示例值：10 |
| DeviceName | 否 | String | 需要过滤的设备名称 示例值：test1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 设备总数 示例值：49 |
| Devices | Array of DeviceInfo | 设备详细信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取设备列表
输入示例
POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDevices
<公共请求参数>
{
"Offset": "0",
"Limit": "10",
"ProductId": "PTROMP3AOB"
}输出示例
{
"Response": {
"RequestId": "9c56647c-17be-4ff7-a80c-245cabe0a42c",
"TotalCount": 49,
"Devices": [
{
"DeviceName": "siva_31337976_1",
"Online": 0,
"LoginTime": 1609293765,
"DevicePsk": "k2o3rxGV0zLHBxabvpszGg==",
"EnableState": 1,
"ExpireTime": 1640681977
},
{
"DeviceName": "siva_31337976_2",
"Online": 0,
"LoginTime": 1609730065,
"DevicePsk": "0FY5jg8MFuapHipHaICb/Q==",
"EnableState": 1,
"ExpireTime": 1640681977
},
{
"DeviceName": "siva_31337976_3",
"Online": 3,
"LoginTime": 0,
"DevicePsk": "csxPuMxoS3NgoawPKtRHRA==",
"EnableState": 1,
"ExpireTime": 1640681977
},
{
"DeviceName": "siva_31337976_4",
"Online": 3,
"LoginTime": 0,
"DevicePsk": "KK1lXS/yy7QHaWBG0xPeMQ==",
"EnableState": 1,
"ExpireTime": 1640681977
},
{
"DeviceName": "siva_31337976_5",
"Online": 3,
"LoginTime": 0,
"DevicePsk": "ptrRs+mGSU2M3P8lu6ronQ==",
"EnableState": 1,
"ExpireTime": 1640681977
},
{
"DeviceName": "siva_31337976_6",
"Online": 3,
"LoginTime": 0,
"DevicePsk": "1xpMhJrnlOLjkcmVEu+foA==",
"EnableState": 1,
"ExpireTime": 1640681977
},
{
"DeviceName": "siva_31337976_7",
"Online": 3,
"LoginTime": 0,
"DevicePsk": "MSm99MKWJGk+JssfngaJNA==",
"EnableState": 1,
"ExpireTime": 1640681977
},
{
"DeviceName": "siva_31337976_8",
"Online": 3,
"LoginTime": 0,
"DevicePsk": "Jeziu8yQXvG/vPpd9jiLlg==",
"EnableState": 1,
"ExpireTime": 1640681977
},
{
"DeviceName": "siva_31337976_9",
"Online": 3,
"LoginTime": 0,
"DevicePsk": "GWnZSYzGsKrfhvXZ5CZ3IQ==",
"EnableState": 1,
"ExpireTime": 1640681977
},
{
"DeviceName": "siva_31337857_9",
"Online": 3,
"LoginTime": 0,
"DevicePsk": "2BxKJKBoqncpl8F/Q/oJxg==",
"EnableState": 1,
"ExpireTime": 1640681857
}
]
}
}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 | 参数错误。 |
| UnsupportedOperation | 操作不支持。 |