API 中心
用户之声——提建议·赢好礼> HOT
文档中心 > API 中心 > 微瓴同业开放平台 > 物联相关接口 > 设备状态获取

设备状态获取

最近更新时间：2024-03-12 02:07:42

我的收藏

本页目录：

1. 接口描述

接口请求域名： weilingwith.tencentcloudapi.com 。

设备状态获取

默认接口请求频率限制：20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDeviceStatusList。
Version 是 String 公共参数，本接口取值：2023-04-27。
Region 是 String 公共参数，详见产品支持的 地域列表。
WorkspaceId 是 Integer 工作空间id
示例值：1016
ApplicationToken 是 String 应用token
示例值：xxx
PageNumber 是 Integer 分页查询，第几页，必传，大于0
示例值：1
PageSize 是 Integer 每页条数，必传大于0
示例值：1
DeviceTypeSet.N 否 Array of String 设备类型
示例值：w010101
ProductIdSet.N 否 Array of Integer 产品 pid
示例值：29
TagIdSet.N 否 Array of Integer 设备标签id

示例值：0
SpaceCodeSet.N 否 Array of String 空间位置（支持空间多层，比如具体建筑、具体楼层）
示例值：100110
WIDSet.N 否 Array of String 设备编号列表

示例值：be2ea997-b7f4-4167-9545-9aa275158a92
DeviceTagSet.N 否 Array of String 设备标签名，非必填
示例值：test
DeviceStatusSet.N 否 Array of String 通信在/离线状态（online=normal+fault、offline）
示例值：online
StatusSet.N 否 Array of String 设备业务状态
（正常-normal、故障-fault、离线-offline）

示例值：normal
IsAlive.N 否 Array of Boolean 推流状态，推流中-true，未推流-false 仅摄像头有的状态
示例值：false

3. 输出参数

参数名称 类型 描述
Result DeviceStatusRes 查询设备状态结果
示例值：{"DeviceStatusSet": [{"DeviceStatus": "online","DeviceStatusUpdateTime": "2023-08-31 00:57:28","IsAlive": true,"Status": "normal","WID": "be2ea997-b7f4-4167-9545-9aa275158a92"}],"PageNumber": 1,"PageSize": 1,"TotalPage": 1,"TotalRow": 1}
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 设备状态查询

正常响应

输入示例

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

{
    "WorkspaceId": 1016,
    "ApplicationToken": "YVySZSL1Lp5UtSJ5uJVLJYOKDEGfCCH2",
    "WIDSet": [
        "be2ea997-b7f4-4167-9545-9aa275158a92"
    ],
    "PageNumber": 1,
    "PageSize": 1
}

输出示例

{
    "Response": {
        "RequestId": "1286216c-1022-4bd6-83a2-3dfb0bee6fe2",
        "Result": {
            "DeviceStatusSet": [
                {
                    "DeviceStatus": "online",
                    "DeviceStatusUpdateTime": "2023-08-31 00:57:28",
                    "IsAlive": true,
                    "Status": "normal",
                    "WID": "be2ea997-b7f4-4167-9545-9aa275158a92"
                }
            ],
            "PageNumber": 1,
            "PageSize": 1,
            "TotalPage": 1,
            "TotalRow": 1
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ApiRuleConfigError Api规则配置信息错误
FailedOperation.RedisOperationFailed redis操作错误
InvalidParameter 参数错误。
InvalidParameterValue.InvalidWorkspaceId 错误的工作空间Id
ResourceNotFound.EmptyDeviceList 空设备列表
UnauthorizedOperation.UnauthorizedApi 应用api的数据授权未配置，请先配置权限
中国站