1. 接口描述
接口请求域名: weilingwith.tencentcloudapi.com 。
设备状态统计
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDeviceStatusStat。 |
Version | 是 | String | 公共参数,本接口取值:2023-04-27。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Level | 是 | Integer | 所属空间地理层级,必填。0表示查询所有层级(1、2)的设备状态,1表示楼栋,2表示楼层 示例值:0 |
WorkspaceId | 是 | Integer | 工作空间id 示例值:1016 |
ApplicationToken | 是 | String | 应用token 示例值:xxx |
SpaceCodeSet.N | 否 | Array of String | 空间位置,非必填。为空表示查询所有(1,2)层级 示例值:100110 |
DeviceTypeSet.N | 否 | Array of String | 设备类型,非必填。为空表示查询所有设备类型 示例值:w02023 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | DeviceStatusStatRes | 设备状态统计结果 示例值:{"DeviceTypeOverviewSet": [{"DeviceType": "w0715010","Fault": 0,"Name": "多功能网关","Normal": 6,"Offline": 8212,"Total": 8218}],"FaultSum": 15,"NormalSum": 87,"OfflineSum": 8689,"StatLevelSet": [],"Total": 8791,"WorkspaceId": 1016} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设备状态统计列表
正常响应
输入示例
POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceStatusStat
<公共请求参数>
{
"Level": 1,
"WorkspaceId": 1016,
"ApplicationToken": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2"
}
输出示例
{
"Response": {
"RequestId": "503f6887-d9af-48b9-91cb-999644f45e63",
"Result": {
"DeviceTypeOverviewSet": [
{
"DeviceType": "w0715010",
"Fault": 0,
"Name": "多功能网关",
"Normal": 6,
"Offline": 8212,
"Total": 8218
}
],
"FaultSum": 15,
"NormalSum": 87,
"OfflineSum": 8689,
"StatLevelSet": [],
"Total": 8791,
"WorkspaceId": 1016
}
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.RedisOperationFailed | redis操作错误 |
InvalidParameterValue.InvalidWorkspaceId | 错误的工作空间Id |