storage.local.format (Format SD card)

storage.local.format: Format SD card

storage.local.format · Device scope · Permission Format

What it does

Formats the local SD card. Input sd.cardIndexs, up to 100 indexes. One invoke runs one format. eMMC format service (thing model std_emmc_format) is not in the open standard—do not send emmc in the request.

Request URL

POST https://openapi-[DataCenter].easy4ip.com/openapi/v2/device.service.invoke

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. A timeout does not mean the operation did not run.

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`
`serviceId`	String	yes	`storage.local.format`
`inputData`	Object	yes	See next section

`inputData` fields

Name	Description	Type	Required	Values
`sd`	SD card struct	`struct`	yes	Includes `cardIndexs`
`sd.cardIndexs`	Card index list	`array`	yes	Up to `100` entries

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",
 "serviceId": "storage.local.format",
 "inputData": {
 "sd": {
 "cardIndexs": [
 0
 ]
 }
 }
 }
}

Response data fields

Output is in result.data.outputData. Empty output is {}.

Response example

{
 "id": "d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "result": {
 "code": "0",
 "msg": "Operation is successful",
 "data": {
 "outputData": {}
 }
 }
}

Error codes

Gateway and device error codes are in Global return codes.

recoverSDCard (legacy HTTP · async data.result code) · Local media