开始使用
  • English
  • 简体中文
前往官网
开始使用
  • English
  • 简体中文
前往官网
  • 开始使用
  • 核心概念
  • 开发指南
  • 设备能力与事件参考
    • 按设备类型浏览
    • 设备能力
      • 通用方法
        • 能力使用
        • device.capability.list(查询可用能力)
        • device.property.get(批量读配置)
        • device.property.set(批量写配置)
        • device.service.invoke(调用一次动作)
      • 侦测与告警
      • 图像
      • 云台
      • 灯光
      • 录像
      • 音频
      • 媒体
      • 网络
      • 电源
      • 隐私
      • 呼叫
      • 存储
      • 系统
      • 算法
      • 设备维护
      • 控制
    • 事件总览
    • 权限码
    • 错误码
    • 告警与能力消息
    • 常见问题
    • 历史能力与推送类型
  • API 参考
  • SDK 与工具
  • 方案
  • 平台与支持
本页目录
功能详情
请求地址
最小权限
传入参数说明
样例输入
返回 data 字段说明
样例输出
错误码

device.property.get(批量读配置)

device.property.get:批量读配置

功能详情

批量读配置或状态的当前值。必须落到一台具体设备。填完整 propertyId。一次请求不能混用设备级与通道级。

请求地址

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get

最小权限

管理员操作自己绑定的设备不需要权限。子用户绑定不需要。被分享设备、子账号所需权限以各属性能力页「最小权限」及 权限码 为准;网关按能力行域码校验,device.capability.list 响应不返回 shareAuthCode/subAccountAuthCode 字段。若属性页另写更高权限,以该页为准。口径与 device.property.get 一致。设备须已绑定(DV2013)。

传入参数说明

参数名参数类型是否必填默认值合法值参数说明
tokenString是管理员、子用户或子账号 accessToken
deviceIdString是设备序列号
productIdString否可省略。传了且与该设备实际型号不一致 → DV2009
channelIdString条件通道号,IPC 常见 "0"。不要传 -1。单通道 IPC 仍要传 "0"读通道级时必填,设备级不要传。一次请求不能混用设备级与通道级(混用返回 DV2008)
propertiesArray是propertyId 字符串要读的项,例如 ["storage.local.capacity"]

公共请求字段与签名见 签名约定 与 公共请求负载。

样例输入

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system": {
 "ver": "1.0",
 "appId": "lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time": 1706511734,
 "nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
 },
 "params": {
 "token": "<yourAccessToken>",
 "deviceId": "TESTIPC000012345",
 "channelId": "0",
 "properties": ["detection.motion.enabled", "image.night.mode"]
 }
}

返回 data 字段说明

参数名参数类型参数说明
propertiesObjectkey 与请求的 propertyId 一一对应
properties.{key}同该项类型当前值。开关为 0/1,枚举为 value

按请求的 properties 数组逐项返回。契约未定义「部分成功」字段,不要按部分成功解析。

样例输出

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "properties": {
 "detection.motion.enabled": 1,
 "image.night.mode": 0
 }
 }
 }
}

错误码

本接口可能返回下列码。

错误码错误码说明下一步
SN1001签名校验异常按 HTTP 开发规范 核对 sign
TK1002token 无效或过期重新获取 accessToken
OP1002缺少必填参数补必填字段
OP1003参数不合法按本页参数表核对
OP1009权限不足核对 token 与设备绑定/分享权限
OP1013接口总次数超限降低调用频率
OP1014接口日限额超限见 接口调用限额
DV1007设备离线等设备上线

更多见 错误码 · OP/SN/TK。

错误码错误码说明下一步
DV2003设备未声明该属性以 device.capability.list 为准
DV2004写入值超出型号范围核对 properties 取值
DV2007channelId 与 scope 不符通道级必传,设备级不传
DV2008同请求混用设备级与通道级拆分请求
DV2009productId 与型号不一致省略或改为实际型号

更多见 能力错误码。

device.capability.list(查询可用能力)
device.property.set(批量写配置)