V2.1 Get Device Statistics


获取特定组织或产品下设备统计信息。

如果你在使用 API 批量更新相关设备状态后调用当前 API,建议两次调用间隔 2 秒左右,以免获取到未更新数据。

该 API 支持在 EnOS 2.2.0 及以上环境中使用。

请求格式

GET https://{apigw-address}/connect-service/v2.1/devices?action=getStats

请求参数(URI)

名称

位置(Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

资产所属的组织ID。 如何获取 orgId 信息>>

productKey

Query

可选

String

设备的 Product Key。如未指定,将获取组织下设备统计信息。如何获取 productKey 信息>>

响应参数

名称

数据类型

描述

data

DeviceStats 结构体

设备的统计信息。结构体的结构参见 DeviceStats 结构体>>

DeviceStats 结构体

名称

数据类型

描述

totalCount

Integer

设备总数。

onlineCount

Integer

在线设备数。

offlineCount

Integer

离线设备数。

inactiveCount

Integer

未激活设备数。

disabledCount

Integer

禁用设备数。

示例

请求示例

url: https://{apigw-address}/connect-service/v2.1/devices?action=getStats&orgId=yourOrgId&productKey=yourProductKey
method: GET

返回示例

{
    "code":0,
    "msg":"OK",
    "requestId":"21e4f294-824b-4eb5-913d-2ca92a230a71",
    "data": {
        "totalCount":100,
        "onlineCount":46,
        "offlineCount":24,
        "inactiveCount":26,
        "disabledCount":4
    }
}

SDK 示例


你可以在 Github 上获取接入服务的 SDK 示例: