You need to enable JavaScript to run this app.
文档中心
智能视联

智能视联

复制全文
下载 pdf
云眸协议
GetHikCloudDeviceStatistics - 设备/摄像头统计
复制全文
下载 pdf
GetHikCloudDeviceStatistics - 设备/摄像头统计

按 space/area/store 任意粒度返回设备与摄像头两段统计,用于控制台顶部 KPI 卡片

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

GetHikCloudDeviceStatistics

要执行的操作,取值:GetHikCloudDeviceStatistics。

Version
String
是

2026-07-01

API的版本,取值:2026-07-01。

SpaceID
String
是

8b629168-70bf-42be-ae15-7d259006bd9e

空间 ID

AreaID
String
否

1001

区域 ID(AreaID/StoreID/StoreNo 三选一)

StoreID
String
否

S001

门店 ID

StoreNo
String
否

A001

业务门店编码

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
ScopeType
String

space

统计范围类型。取值:space/area/store

ScopeID
String

3ddb2a11-1eca-4a31-a0ce-788a83389762

范围 ID

ScopeName
String

xx门店

范围名称(space/area/store)

Device
Object

{
"Total": 207299,
"Online": 195234,
"Offline": 12065,
"OnlineRate": 94
}

设备统计

Camera
Object

{
"Total": 207307,
"Online": 195223,
"Offline": 12076,
"Unknown": 8,
"OnlineRate": 94
}

摄像头统计

请求示例

GET /?Action=GetHikCloudDeviceStatistics&Version=2026-07-01&SpaceID=8b629168-70bf-42be-ae15-7d259006bd9e&AreaID=1001&StoreID=S001 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20260711T120000Z
X-Content-Sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Authorization: HMAC-SHA256 Credential=AKLT********/20260711/cn-beijing/aiotvideo/request, SignedHeaders=host;x-content-sha256;x-date, Signature=****************************************

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2026071120000000000000000000000000",
    "Action": "GetHikCloudDeviceStatistics",
    "Version": "2026-07-01",
    "Service": "aiotvideo",
    "Region": "cn-beijing",
    "Error": null
  },
  "Result": {
    "ScopeType": "area",
    "ScopeID": "1001",
    "ScopeName": "北京市",
    "Device": {
      "Total": 100,
      "Online": 95,
      "Offline": 5,
      "OnlineRate": 95
    },
    "Camera": {
      "Total": 200,
      "Online": 190,
      "Offline": 8,
      "Unknown": 2,
      "OnlineRate": 95
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
401
hik_credential_invalid

Invalid HikCloud credential

ClientID/ClientSecret 无效或 token 获取失败

401
credential_invalid

Credential expired or invalid

鉴权信息已失效,请重新验证凭证

403
forbidden

Access denied

空间不属于当前 AccountID

403
hik_no_permission

No permission

无数据操作权限

500
hik_cloud_not_configured

HikCloud service not configured

服务未配置 master_key 或 TOS

最近更新时间:2026.07.24 13:52:32
这个页面对您有帮助吗?
有用
有用
无用
无用