URL 批量拉取上传完成事件--视频点播-火山引擎

文档中心

立即注册

导航

URL 批量拉取上传完成事件

最近更新时间：2024.09.04 15:59:09首次发布时间：2021.02.23 10:42:38

本文为您介绍 URL 批量拉取上传完成事件。

事件类型

FileUploadByUrlComplete

事件说明

配置了 URL 批量上传完成事件通知后，每个 URL 上传完成时您将收到通知。配置方法详见事件通知概览。关联接口：URL 批量拉取上传。

事件内容

参数	类型	示例值	说明
RequestId	String	`202405060***0CF1866`	请求的唯一 ID
Version	String	`1.0`	回调版本
EventType	String	`FileUploadComplete`	事件名称
EventTime	String	`2024-05-06T09:49:33Z`	事件产生时间，UTC 时间，精度为秒。
Data	Data	`-`	回调内容，JSON 格式。

Data

参数	类型	描述
Code	String	错误码
Message	String	具体错误信息
JobId	String	任务 ID
SourceUrl	String	片源 URL 地址
CallbackArgs	String	回调透传信息。如果您在上传时设置了 `CallbackArgs` 参数，在事件完成回调时会将用户自定义数据透传返回。
Vid	String	视频 ID
SpaceName	String	点播空间名称
SourceInfo	SourceInfo	片源信息
PosterUri	String	视频封面图 URI。仅当您在上传时设置了视频封面，返回该参数。具体请见设置视频封面。
OptionInfo	OptionInfo	媒资信息

SourceInfo

片源信息

参数	类型	描述
StoreUri	String	文件存储位置
Height	Integer	视频高度，单位为 px
Width	Integer	视频宽度，单位为 px
Duration	Float	视频时长，单位为秒
Bitrate	Integer	视频码率，单位为 bps
Md5	String	文件 MD5 值
Format	String	文件格式
Size	Integer	文件大小，单位为字节
HlsMediaSize	Integer	HlS 视频总大小，单位为字节。HLS 视频包含 M3U8 和 TS 文件。
FileName	String	文件路径

OptionInfo

媒资信息

参数	类型	描述
TemplateId	String	工作流 ID。注意 `TemplateId` 已废弃，推荐使用 `Templates` 参数。
Templates	Array of of Template	工作流信息。

Template

工作流信息

参数	类型	示例	描述
TemplateIds	[]string	`["abcd***123"]`	工作流 ID。
TemplateType	String	`transcode`	工作流类型。取值如下： `transcode`: （默认）在视频点播服务中创建的工作流。 `imp`: 在智能处理服务中创建的工作流。

参数

类型

示例

描述

TemplateIds

[]string

["abcd***123"]

工作流 ID。

TemplateType

String

transcode

工作流类型。取值如下：

transcode: （默认）在视频点播服务中创建的工作流。
imp: 在智能处理服务中创建的工作流。

回调示例

上传成功回调示例

{
    "RequestId": "2020072711510***05207114001CC4",
    "Version": "1.0",
    "EventType": "FileUploadByUrlComplete",
    "EventTime": "2020-07-27T11:04:05Z"，
    "Data": {
        "Code": "Success",
        "Message": "file upload success",
        "JobId": "f08d26b0e963***9f208c1ca79cfd5d",
        "SourceUrl": "http://xxx.mp4",
        "CallbackArgs": "item id",
        "Vid": "v02af6e500***3pbvh148u6ung0",
        "SpaceName": "ecqc-live",
        "SourceInfo": {
            "StoreUri": "",
            "Md5": "",
            "Width": 544,
            "Height": 960,
            "Duration": 143.98,
            "Bitrate": 0,
            "Format": "mp4",
            "FileName": "e4c13e5505874e***4b1e74c8616",
            "Size": 1024,
        },
        "PosterUri": "tos-cn-v-f4fc******505874e58908b94b1e74c8616"
        "OptionInfo":{
            "TemplateId":"aaa"
            "Templates": [{
                "TemplateIds": ["templateId1"],
                "TemplateType": "imp"
            },
            {
                "TemplateIds": ["aaa"],
                "TemplateType": "transcode"
            }
            ]
        }
    }
}

上传失败回调示例

{
    "RequestId":"202206161501***216519620B65717",
    "Version":"1.0",
    "EventTime":"2022-06-16T15:02:08Z",
    "EventType":"FileUploadByUrlComplete",
    "Data":{
        "Code":"DownloadFailed.UrlDownloadFail",
        "Message":"404 Not Found",
        "JobId":"3f91953e99***9e9044ab8eb98bd8",
        "SourceUrl":"https://stream7.iqilu.com/******transcode/202002/18/ooooooooooooooo.mp4",
        "CallbackArgs":"",
        "Vid":"",
        "SpaceName":"vod-v2-test",
        "SourceInfo":{
            "StoreUri":"",
            "Width":0,
            "Height":0,
            "FileName": "e4c13e5505874e***4b1e74c8616",
            "FileType":""
        },
        "PosterUri":"",
        "OptionInfo":{
            "TemplateId":""
        }
    }
}

回调错误码

错误码	说明
Success	上传成功
InvalidParameter.InvalidParam	入参错误，如 `url` 传的不是 HTTP 开头，传了个随机字符串等。
DownloadFailed.UrlDownloadFail	下载视频报错。可能是资源不存在或提供资源的服务异常或网络异常。
CheckError.Md5MissMatch	入参传入的 Md5 与实际的 Md5 不匹配。
UploadFailed.UrlUploadFailed	上传时发生错误，一般为后台异常。
InternalError.UrlUploadError	服务端上传内部错误，一般为依赖服务异常。
OperationDenied.DenyOverwriteUpload	禁止不同文件以相同 `FileName` 覆盖上传。