API参考

优质
小牛编辑
128浏览
2023-12-01

接口目录

上传文件

POST /storage/api/upload

该接口为同步接口,上传完成后能马上得到文件 URL

表单参数

参数描述取值
file文件file
file_name(可选)自定义文件名,需要带上扩展名。默认用上传文件的文件名string

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
id文件云存储 IDstring
url文件云存储 URLstring

返回示例:

{
    "errcode": 1000,
    "msg": "OK",
    "id": "a4b9dnoj",
    "url": "http://example.mudu.tv/a4b9dnoj-example.txt"
}

下载URL上的文件到云存储

POST /storage/api/download_url

该接口为异步接口,调用后马上返回,需要通过查询文件状态来确认是否上传完成

JSON 参数

参数描述取值
file_url文件来源 URLstring
file_name(可选)文件名,带扩展名。默认用文件来源 URL 路径的最后一部分string

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
id文件云存储 IDstring

返回示例:

{
    "errcode": 1000,
    "msg": "OK",
    "id": "a4b9dnoj"
}

获取文件列表

GET /storage/api/list

URL 参数

参数描述取值
page页数,默认 1int
page_size每页个数,默认 15int

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
count文件总个数int
files云存储文件列表object array
files.id文件云储存 IDstring
files.status文件状态(见下)int
files.source_type来源类型(url 或 file)string
files.public_url文件 URLstring
files.file_name文件名string
files.file_size文件大小(字节数)int

文件状态表:

意义
0初始状态
1上传成功(这是最终状态)
2上传中
3上传失败
4已删除

返回示例:

{
    "errcode": 1000,
    "msg": "OK",
    "count": 234,
    "files": [{
        "id": "dok80b1y",
        "status": 1,
        "source_type": "url",
        "public_url": "http://example.mudu.tv/a4b9dnoj-example.mp4",
        "file_name": "example.mp4",
        "file_size": 68520395
    }]
}

获取文件信息

GET /storage/api/get

URL 参数

参数描述取值
id文件云储存 IDstring

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
file云存储文件object
file.id文件云存储 IDstring
file.status文件状态(见下)int
file.source_type来源类型(url 或 file)string
file.public_url文件 URLstring
file.file_name文件名string
file.file_size文件大小(字节数)int

文件状态表:

意义
0初始状态
1上传成功(这是最终状态)
2上传中
3上传失败
4已删除

返回示例:

{
    "errcode": 1000,
    "msg": "OK",
    "file": {
        "id": "dok80b1y",
        "status": 1,
        "source_type": "url",
        "public_url": "http://example.mudu.tv/a4b9dnoj-example.mp4",
        "file_name": "example.mp4",
        "file_size": 68520395
    }
}

删除文件信息

POST /storage/api/delete

URL 参数

参数描述取值
id文件云储存 IDstring

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string

返回示例:

{
    "errcode": 1000,
    "msg": "OK"
}

初始化分片任务

POST /storage/api/init_upload_part

注意:获取到的 upload_id 用于后面 /upload_part, /complete_upload_part/abort_upload_partid 字段

JSON 参数

参数描述取值
file_name(必填)待上传的文件名,带扩展名string

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
upload_id分片上传任务 IDstring

返回示例:

{
    "errcode": 1000,
    "msg": "OK",
    "upload_id": "mok80b1y"
}

上传分片文件

POST /storage/api/upload_part

URL 参数

参数描述取值
id分片上传任务 IDstring

表单参数:

参数描述取值
file文件file
part_number分片号,从 1 开始int

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string

返回示例:

{
    "errcode": 1000,
    "msg": "OK"
}

完成分片上传

POST /storage/api/complete_upload_part

URL 参数

参数描述取值
id分片上传任务 IDstring

JSON 参数:

参数描述取值
parts_count总分片数,用于检查文件完整性int

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
id文件云储存 IDstring

返回示例:

{
    "errcode": 1000,
    "msg": "OK",
    "id": "dvoneo63"
}

取消分片上传

POST /storage/api/abort_upload_part

URL 参数

参数描述取值
id分片上传任务 IDstring

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string

返回示例:

{
    "errcode": 1000,
    "msg": "OK"
}

获取分片上传任务

GET /storage/api/get_upload_part_task

URL 参数

参数描述取值
id分片上传任务 IDstring

返回字段

参数描述取值
errcode错误码,1000 为正常int
msg"OK" 或错误信息string
task分片上传任务object
task.upload_id分片上传任务 IDstring
task.status分片任务上传状态(定义见下表)int
task.uploaded_parts已上传的分片号(从 1 开始)int array
task.file_name文件名string

分片任务状态表:

意义
0初始状态,上传中
1上传成功(这是最终状态)
2已取消

返回示例:

{
    "errcode": 1000,
    "msg": "OK",
    "task": {
        "upload_id": "mok80b1y",
        "status": 0,
        "uploaded_parts": [1, 2, 4, 5, 7],
        "file_name": "example.mp4"
    }
}

错误码

错误代码使用模块错误描述
2301存储参数不合法
2302存储上传失败:分片缺失
2303存储无法从提供的 URL 获取文件
2304存储不是有效的 m3u8 文件
2305存储UploadID 无效
2306存储找不到该 user ID 对应的 token,请登录后重试
2311存储内部错误:创建临时文件失败
2312存储内部错误:修改临时文件失败
2313存储内部错误:删除临时文件失败
2314存储内部错误:无法将文件上传至云存储
2315存储内部错误:无法获取云存储上的对象地址
2316存储内部错误:无法将文件上传至云存储
2317存储内部错误:解析 HTTP 返回失败
2321存储插入文件数据失败
2322存储查询单个文件数据失败
2323存储修改文件数据失败
2324存储删除文件数据失败
2325存储查询文件数据列表失败
2331存储插入文件片段任务数据失败
2332存储查询单个文件片段任务数据失败
2333存储修改文件片段任务数据失败
2334存储删除文件片段任务数据失败
2341存储保存文件片段数据失败