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)。
传入参数说明
| 参数名 | 参数类型 | 是否必填 | 默认值 | 合法值 | 参数说明 |
|---|---|---|---|---|---|
token | String | 是 | 管理员、子用户或子账号 accessToken | ||
deviceId | String | 是 | 设备序列号 | ||
productId | String | 否 | 可省略。传了且与该设备实际型号不一致 → DV2009 | ||
channelId | String | 条件 | 通道号,IPC 常见 "0"。不要传 -1。单通道 IPC 仍要传 "0" | 读通道级时必填,设备级不要传。一次请求不能混用设备级与通道级(混用返回 DV2008) | |
properties | Array | 是 | 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 字段说明
| 参数名 | 参数类型 | 参数说明 |
|---|---|---|
properties | Object | key 与请求的 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 |
TK1002 | token 无效或过期 | 重新获取 accessToken |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1009 | 权限不足 | 核对 token 与设备绑定/分享权限 |
OP1013 | 接口总次数超限 | 降低调用频率 |
OP1014 | 接口日限额超限 | 见 接口调用限额 |
DV1007 | 设备离线 | 等设备上线 |
更多见 错误码 · OP/SN/TK。
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV2003 | 设备未声明该属性 | 以 device.capability.list 为准 |
DV2004 | 写入值超出型号范围 | 核对 properties 取值 |
DV2007 | channelId 与 scope 不符 | 通道级必传,设备级不传 |
DV2008 | 同请求混用设备级与通道级 | 拆分请求 |
DV2009 | productId 与型号不一致 | 省略或改为实际型号 |
更多见 能力错误码。
