storage.local.capacity(获取存储信息属性)
storage.local.capacity:获取存储信息属性
storage.local.capacity · 设备级 · 权限 Format
功能详情
读设备本地 SD 卡存储信息。公开整段 array,一次返回该机全部 SD 卡。元素字段为 index / totalBytes / usedBytes / storageState / storageAbnormal。单卡机 index 仍为 0。properties 传字符串 propertyId 或点位 ref。
请求地址
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get
最小权限
管理员操作自己绑定的设备不需要权限。操作被分享设备须具备 storage.local 能力行 share_auth_code 所列权限之一(与控制台「存储管理权限」一致)。子用户绑定不需要。子账号需要 Format。设备级勿传 channelId;勿在同一 device.property.get/set 中混用 device 与 channel 属性(DV2008)。详见 权限码。
传入参数说明
| 参数名 | 参数类型 | 是否必填 | 参数说明 |
|---|---|---|---|
token | String | 是 | 管理员、子用户或子账号 accessToken |
deviceId | String | 是 | 设备序列号 |
productId | String | 否 | 可省略。传了且与该设备实际型号不一致 → DV2009 |
properties | Array | 是 | ["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",
"properties": [
"storage.local.capacity"
]
}
}
返回 data 字段说明
值在 result.data.properties["storage.local.capacity"]。
| 参数名 | 说明 | 类型 | 必填 | 取值 |
|---|---|---|---|---|
item.index | 卡索引。范围 0~100,步长 1。单卡仍为 0。 | int | 是 | 0~100,步长 1 |
item.totalBytes | 总存储。范围 0~999999,步长 1,单位 byte。 | int | 是 | 0~999999,步长 1,单位 byte |
item.usedBytes | 已用空间。范围 0~999999,步长 1,单位 byte。 | int | 是 | 0~999999,步长 1,单位 byte |
item.storageState | 存储介质状态。 | enum | 是 | 0 存储介质不存在;1 正常状态;2 存储介质异常,需要初始化;3 重启;4 初始化开始;5 初始化失败;6 初始化成功;7 盘检状态;8 未初始化 |
item.storageAbnormal | 存储介质异常状态。 | enum | 是 | 1 SD 卡加密且未认证解密;2 SD 卡寿命已尽;3 普通异常提示格式化;4 SD 卡不支持寿命查询;5 SD 卡盘检中;6 SD 卡格式不支持;7 SD 卡挂载失败;8 SD 卡读错误;9 SD 卡写错误;10 SD 卡分区错误;11 SD 卡只读 |
样例输出
{
"id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result": {
"code": "0",
"msg": "Operation is successful",
"data": {
"properties": {
"storage.local.capacity": [
{
"index": 0,
"totalBytes": 0,
"usedBytes": 0,
"storageState": 0,
"storageAbnormal": 1
}
]
}
}
}
}
错误码
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
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 与型号不一致 | 省略或改为实际型号 |
更多见 能力错误码。
