API参考

接口目录

• 创建视频
• 获取视频列表
• 获取单个视频
• 获取分享视频
• 搜索视频
• 更新视频名称、视频封面等视频信息
• 设置视频分享密码
• 查询该用户所有视频的已用空间
• 转码视频
• 删除视频
• 批量删除视频
• 查询单个视频的每分钟流量
• 查询视频总流量，分页
• 导出视频总流量，分页
• 查询该用户上传的所有视频的每日流量之和
• 导出该用户上传的所有视频的每日流量之和，一天一条数据
• 获取该用户上传的所有视频的总流量之和
• 错误码
• 消息通知
• 判断视频能否合并

创建视频

POST /video/api/create

需要先调用存储微服务的接口，如 /storage/api/upload 等，上传视频，获取到 storage_id

JSON 参数

返回字段

返回示例：

{
    "errcode": 1000,
    "id": "17lok52y",
    "msg": "OK"
}

获取视频列表

GET /video/api/list

视频状态表：

转码视频状态表：

URL 参数

返回字段

返回示例：

{
    "count": 33,
    "errcode": 1000,
    "msg": "OK",
    "videos": [
        {
            "id": "17lok52y",
            "created_at": "2010-11-22T15:16:17+08:00",
            "updated_at": "2010-11-22T15:16:17+08:00",
            "source_type": "1",
            "source_id": "1",
            "status": 1,
            "storage_id": "1",
            "origin_url": "1",
            "thumb_url": "1",
            "file_size": 1,
            "video_name": "1",
            "video_width": 1,
            "video_height": 1,
            "video_duration": 1,
            "shared_state": 1,
            "share_password": "5zpr0kpzo",
            "play_set": [
                {
                    "created_at": "2010-11-22T15:16:17+08:00",
                    "updated_at": "2010-11-22T15:16:17+08:00",
                    "storage_id": "1",
                    "status": 1,
                    "trans_progress": 1,
                    "trans_task_config_temp_id": 1,
                    "url": "1",
                    "file_size": 1,
                    "video_width": 1,
                    "video_height": 1,
                    "video_duration": 1,
                    "resolution": "360P"
                }
            ]
        }
    ]
}

获取单个视频

GET /video/api/get

URL 参数

返回字段

返回示例：

{
    "errcode": 1000,
    "msg": "OK",
    "video": {
        "id": "17lok52y",
        "created_at": "2010-11-22T15:16:17+08:00",
        "updated_at": "2010-11-22T15:16:17+08:00",
        "source_type": "1",
        "source_id": "1",
        "status": 1,
        "storage_id": "1",
        "origin_url": "1",
        "thumb_url": "1",
        "file_size": 1,
        "video_name": "1",
        "video_width": 1,
        "video_height": 1,
        "video_duration": 1,
        "shared_state": 1,
        "share_password": "5zpr0kpzo",
        "play_set": [
            {
                "created_at": "2010-11-22T15:16:17+08:00",
                "updated_at": "2010-11-22T15:16:17+08:00",
                "storage_id": "1",
                "status": 1,
                "trans_progress": 1,
                "trans_task_config_temp_id": 1,
                "url": "1",
                "file_size": 1,
                "video_width": 1,
                "video_height": 1,
                "video_duration": 1,
                "resolution": "360P"
            }
        ]
    }
}

获取分享视频

GET /video/api/get_shared_video

若访问该视频需要密码，当密码一致时才能获取该视频

URL 参数

返回内容同获取单个视频

搜索视频

GET /video/api/search

• 根据视频 ID 搜索
• 根据视频名称模糊搜索
• 根据视频来源搜索

URL 参数

返回字段和示例同获取视频列表

更新视频名称、视频封面等视频信息

POST /video/api/update

（更新封面时，原封面会被删除）

URL 参数

JSON 参数

返回字段

返回示例：

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

设置视频分享密码

POST /video/api/set_video_password

URL 参数

JSON 参数

返回字段

返回示例：

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

查询该用户所有视频的已用空间

GET /video/api/get_video_size_sum

返回字段

返回示例：

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

转码视频

POST /video/api/trans

说明：若调用转码时存储的原始文件还没准备好，是无法转码的，可以在创建点播并成功收到 video_ready 回调之后，再去调用转码

URL 参数

JSON 参数

返回字段

返回示例：

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

删除视频

POST /video/api/delete

视频、视频的转码、视频封面也会被删除

URL 参数

返回字段

返回示例：

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

批量删除视频

POST /video/api/delete_videos

视频、视频的转码、视频封面也会被删除

URL 参数

返回字段

返回示例：

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

查询单个视频的每分钟流量

GET /video/api/list_video_statistic

可以查询跨度在90天内的该视频的流量数据，即查询该视频的 [start, end] 时间范围内的每分钟流量，且 end-start<=90天

URL 参数

返回字段

查询视频总流量，分页

GET /video/api/list_video_total_summary

可以选择如下查询方式：

• 按视频 ID 查询
• 按视频名称查询
• 按视频创建时间查询，即 start<=视频创建时间<=end，且 end-start<=90天

URL 参数

返回字段

导出视频总流量，分页

GET /video/api/export_video_total_summary

可以选择如下查询方式：

• 按视频 ID 查询
• 按视频名称查询
• 按视频创建时间查询，即 start<=视频创建时间<=end，且 end-start<=90天

URL 参数

返回一个 CSV 文件

查询该用户上传的所有视频的每日流量之和

GET /video/api/list_user_video_day_summary

可以查询跨度在90天内的每日流量之和，即 [start, end] 时间范围内的每日流量之和，且 end-start<=90天

URL 参数

返回字段

导出该用户上传的所有视频的每日流量之和，一天一条数据

GET /video/api/export_user_video_day_summary

可以查询跨度在90天内的每日流量之和，即 [start, end] 时间范围内的每日流量之和，且 end-start<=90天

URL 参数

返回一个 CSV 文件

获取该用户上传的所有视频的总流量之和

GET /video/api/get_user_video_total_summary

返回字段

错误码

消息通知

0.在 svc_notify.user_event_config 中配置要回调的用户和回调地址，例如

36 video http://bugu.198dev.myun.tv:10080/videos/api/video_callback http 36 transcoding http://bugu.198dev.myun.tv:10080/videos/api/transcode_callback http

1.视频和转码的视频准备好（即其 Status 为 1）后，会调用消息通知微服务，发送视频数据

2.视频准备好后发送：

参数|描述|类型| |-------|--------|--------| |event_type|事件类型，值为 "video_ready" |string| |video_id|视频 ID|string| |storage_id|存储 ID|string| |source_type|上传来源类型|string| |source_id|来源 hash ID|string| |url_origin|原片 URL|string| |thumb_url|视频封面 URL|string| |file_size|视频文件大小|int| |video_name|视频名称|string| |video_width|视频宽|int| |video_height|视频高|int| |video_duration|视频时长|int| |play_set|视频转码的数据（定义见下表）|object array|

其中 play_set 是一个对象数组，对象描述：

若用户有转码配置，play_set 会包含一个转码数据；否则 play_set 为空

3.转码视频准备好后发送：

判断视频能否合并

POST /video/api/can_videos_be_merged

仅限 M3U8 链接

JSON 参数

返回字段

返回示例：

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