storage.local.capacity (Read storage info)
storage.local.capacity: Read storage info
storage.local.capacity · Device scope · Permission Format
What it does
Reads local SD-card storage. The public value is an array of all SD cards. Each item has index / totalBytes / usedBytes / storageState / storageAbnormal. A single-card device still uses index 0. Pass properties as a string propertyId or a point ref.
Request URL
POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.property.get
Minimum permission
The administrator does not need an extra permission on a device they bound. A shared device needs the storage management permission. A bound sub-user does not. A sub-account needs Format.
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
token | String | yes | Administrator, sub-user, or sub-account accessToken |
deviceId | String | yes | Device serial number |
productId | String | no | Optional. If sent and it does not match the device model → DV2009 |
properties | Array | yes | ["storage.local.capacity"] |
Common request fields and signing: Signing and Common request payload.
Request example
{
"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"
]
}
}
Response data fields
The value is in result.data.properties["storage.local.capacity"].
| Name | Description | Type | Required | Values |
|---|---|---|---|---|
item.index | Card index. Range 0–100, step 1. Still 0 on a single-card device. | int | yes | 0–100, step 1 |
item.totalBytes | Total capacity. Range 0–999999, step 1, unit byte. | int | yes | 0–999999, step 1, unit byte |
item.usedBytes | Used space. Range 0–999999, step 1, unit byte. | int | yes | 0–999999, step 1, unit byte |
item.storageState | Media state. | enum | yes | 0 no media; 1 normal; 2 media abnormal, initialization required; 3 reboot; 4 initialization started; 5 initialization failed; 6 initialization succeeded; 7 disk check; 8 not initialized |
item.storageAbnormal | Media abnormal state. | enum | yes | 1 SD encrypted and not authenticated; 2 SD end of life; 3 general abnormal, format suggested; 4 SD does not support life query; 5 SD disk check in progress; 6 SD format not supported; 7 SD mount failed; 8 SD read error; 9 SD write error; 10 SD partition error; 11 SD read-only |
Response example
{
"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"
}
]
}
}
}
}
Error codes
Gateway and device error codes are in Global return codes.