start-disk-format 接口
新增于 V2.2
对磁盘进行格式化,操作后数据无法恢复,并且格式化过程不可取消。
进行格式化时,必须满足以下条件:
- 未进行固件升级
- 未进行重置和重启
- 未启用录制功能
- 磁盘有效
通过 get-status 接口可以获取到以下信息:
"cur-status": 65552 // 设备运行状态掩码
"disk-info": [
{
"disk-status": 1, // SD 卡状态掩码
"disk-type": 1, // 0: U 盘,1:SD 卡
"total-size": 61638148096,
"used-size": 97058816,
...
}
]
cur-status
和 设备状态掩码 进行与运算,可以得到以下状态表:
状态 | 条件 |
---|---|
未进行固件升级 | cur-status & statusUpgrade != statusUpgrade |
未进行重置 | cur-status & statusReset != statusReset |
未进行重启 | cur-status & statusReboot != statusReboot |
未启用录制功能 | cur-status & statusRecord != statusRecord |
disk-status
和 存储设备状态码 进行与运算,可以得到以下状态表:
状态 | 条件 |
---|---|
磁盘有效 | disk-status & DiskValid = DiskValid |
请求方式
GET http://ip/usapi?method=start-disk-format&disk-type=0
参数 | 说明 |
---|---|
method | 方法名称:start-disk-format |
disk-type | 存储类型 0:U 盘 1:SD 卡 |
返回数据
{
"result": 0
}
属性 | 说明 |
---|---|
result | 返回状态。 0:开始格式化 1:操作重复 -5:磁盘错误 -9:系统忙 返回其它值请参考 API 状态码 |
格式化过程状态
通过 get-status 接口可以获取到 format-status 信息,如下:
"format-status": {
"result": 27,
"percent": 20,
"client-id": ""
}
属性 | 说明 |
---|---|
result | 操作状态。 27:初始状态 2:格式化中状态 0:操作成功 返回其它值请参考 API 状态码 |
percent | 格式化进度:20 表示 20% |
client-id | 保留属性 |
磁盘格式化后,需要调用 clear-disk-format 接口将格式化状态重置为初始状态(27)。