@sewise-dev
2017-05-17T01:58:43.000000Z
字数 4961
阅读 658
微录播 云平台
| 编号 | 版本 | 说明 | 作者 | 日期 |
|---|---|---|---|---|
| 1 | v1.0 | 1.微录播相关接口 | pakison | 2017-05-09 |
创建相机目录
/catalog
application/json
POST
参数 必选 类型 说明 RequestBody name 是 string 目录名称 type 是 string 目录类型,1:相机目录；2：默认目录；3：合成视频;4:自定义目录
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 添加任务结果 |
| error | string | 错误信息，如错误，返回，否则没有 |
其他响应状态描述请参照：【备注】-【错误码】
Request
url: http://ip:port/catalog
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}
创建相机目录
/catalog
application/json
PUT
参数 必选 类型 说明 RequestBody name 是 string 目录名称 uuid 是 string 目录的uuid
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 添加任务结果 |
| error | string | 错误信息，如错误，返回，否则没有 |
其他响应状态描述请参照：【备注】-【错误码】
Request
url: http://ip:port/catalog
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}
删除相机目录
/catalog
application/json
POST
参数 必选 类型 说明 RequestBody name 是 string 目录名称 type 是 string 目录类型,1:相机目录；2：默认目录；3：合成视频;4:自定义目录
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 添加任务结果 |
| error | string | 错误信息，如错误，返回，否则没有 |
其他响应状态描述请参照：【备注】-【错误码】
Request
url: http://ip:port/catalog
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}
创建相机目录
/catalog/list
application/json
POST
参数 必选 类型 说明 RequestBody name 是 string 目录名称 type 是 string 目录类型,1:相机目录；2：默认目录；3：合成视频;4:自定义目录
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 添加任务结果 |
| error | string | 错误信息，如错误，返回，否则没有 |
其他响应状态描述请参照：【备注】-【错误码】
Request
url: http://ip:port/catalog
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}
提交切片上传任务
/upload/uuid
application/json
POST
参数 必选 类型 说明 RequestBody fileName 是 string 文件的名称 size 否 int 文件的总大小 chunkSize 是 int 单个切片的大小 catType 否 int 视频目录类型，1:相机目录；2：默认目录；3：合成视频;4:自定义目录 catUuid 否 string 视频目录的uuid
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 添加任务结果 |
| uuid | string | 切片上传的任务id |
| error | string | 错误信息，如错误，返回，否则没有 |
其他响应状态描述请参照：【备注】-【错误码】
Request
url: http://ip:port/upload/uuid
Response
成功:{"success":true,uuid:'adsaddhadherdha'}
失败:{"success":false,"error":"XXX"}
上传切片
/upload/uuid/:uuid
formdata/multipart
POST
参数 必选 类型 说明 RequestBody uuid 是 string 切片上传的任务id
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 单个切片上传结束结果 |
| completed | boolean | 是否全部上传完成 |
| path | string | 上传成功后返回的文件地址 |
| error | string | 错误信息，如错误，返回，否则没有 |
其他响应状态描述请参照：【备注】-【错误码】
Request
url: http://ip:port/upload/uuid/agsdagsdgdaegaeada
Response
成功:{"success":true,path:'storage/storage/public/lubocam/upload_e48938464fd88d99b.mp4'}
失败:{"success":false,"error":"XXX"}
获取切片上传的任务信息，主要用于断点续传
/upload/resume/:uuid
application/json
GET
参数 必选 类型 说明 RequestBody uuid 是 string 切片上传的任务id
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 单个切片上传结束结果 |
| error | string | 错误信息，如错误，返回，否则没有 |
| fileName | string | 文件的名称 |
| size | string | 文件的总大小 |
| chunkSize | int | 单个切片大小 |
| lastIndex | int | 总共有多少个切片 |
| index | int | 上传的最后一个切片的位置 |
其他响应状态描述请参照：【备注】-【错误码】
Request
url: http://ip:port/upload/resume/agsdagsdgdaegaeada
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}
获取相机目录列表
/source/list/:type
application/json
get
参数 必选 类型 说明 RequestBody type 是 string 文件的类型，eg:mp4、pic、pdf size 否 int 每一页的条数 page 否 int 获取第几页的资源 catType 否 int 视频目录类型，1:相机目录；2：默认目录；3：合成视频;4:自定义目录 catUuid 否 string 视频目录的uuid
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 添加任务结果 |
| data | arr | 相机目录数组 |
其他响应状态描述请参照：【备注】-【错误码】
Request
url: http://ip:port/camera/list
Response
成功:{"success":true,data:[{}，{}]}
失败:{"success":false,"error":"XXX"}
创建相机目录
/source/:uuid
application/json
PUT
参数 必选 类型 说明 RequestBody uuid 是 string 资源的唯一ID type 是 string 资源的类型 name 是 string 修改的资源名称
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 添加任务结果 |
| error | string | 错误信息，如错误，返回，否则没有 |
其他响应状态描述请参照：【备注】-【错误码】
Request
url: http://ip:port /source/:uuid
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}
获取相机目录列表
/source/download
application/json
get
参数 必选 类型 说明 RequestBody path 是 string 文件的路径,即fullname
200
Request
url: http://ip:port/source/download?path=storage/public/lubocam/17727685670/111/002_VID00114_20160913214116.mp4
创建相机目录
/source/move/:uuid
application/json
POST
参数 必选 类型 说明 RequestBody uuid 是 string 资源的唯一ID catType 是 int 视频目录类型，1:相机目录；2：默认目录；3：合成视频;4:自定义目录 catUuid 否 array 视频目录的uuid,数组,["xxx","xxx","xxx"]
200
| 返回字段 | 字段类型 | 说明 |
|---|---|---|
| success | boolean | 添加任务结果 |
| error | string | 错误信息，如错误，返回，否则没有 |
其他响应状态描述请参照：【备注】-【错误码】
Request
url: http://ip:port /source/move/:uuid
Response
成功:{"success":true}
失败:{"success":false,"error":"XXX"}