全部产品
云市场

URL批量拉取上传

更新时间:2019-07-10 16:27:12

描述

基于源文件URL,拉取媒体文件进行上传。上传完成后会收到 URL上传视频完成 事件通知,可以通过获取URL上传信息查询上传状态。

说明:

  1. 提交成功后,会在云端生成异步执行的任务,进行排队执行;上传完成后可根据事件通知(消息回调)返回的URL和视频ID等信息进行关联。
  2. URL拉取上传的时效性较低,主要针对离线搬站场景,一般提交后会在数小时、甚至数天内完成迁移上传。如果想要更实时,建议使用 服务端上传SDK,其会在本地实时下载和上传。

请求参数

名称类型是否必需描述
ActionString系统规定参数。取值:UploadMediaByURL。
UploadURLs String视频源文件URL。
  • URL中需要包括扩展名, 比如 https://xxxx.mp4 中mp4为扩展名,如果URL中不包含扩展名,可以在UploadMetadatas中传入FileExtension来指定,如果URL中有扩展名且同时传入FileExtension,以传入的FileExtension为准。指定支持的扩展名参见 上传概述 的限制部分。
  • URL编码,多个以逗号分隔,最多支持20个。
  • 避免存在特殊字符导致无法上传视频,需要URL编码后再做逗号拼接。
TemplateGroupIdString转码模板组ID。
  • 可在 点播控制台 > 转码设置 里查看模版组ID。
  • 不为空时,会使用指定的模板组进行转码。
  • 可以在UploadMetadatas中进行设置。
WorkflowIdString工作流ID。
注意:如果同时传递了WorkflowId和TemplateGroupId,以WorkflowId为准。使用说明参考文档 工作流
StorageLocationString视频存储区域。可在点播控制台-存储管理查看可用存储地址,不指定时会使用默认存储。
UploadMetadatasUploadMetadata[]上传视频元数据信息,为JSON字符串。
  • 与UploadURLs里的URL匹配才能生效。
  • Json格式:[UploadMetadata, UploadMetadata,…],需转为JSON字符串 。
  • 参考下表:UploadMetadata。
UserDataUserData自定义设置。为JSON字符串。支持消息回调等设置。
AppIdString应用ID。取值如:app-1000000。使用说明参考文档 多应用

UploadMetadata

名称类型是否必需描述
SourceURL String需要上传的视频源文件URL。
Title String视频标题。
  • 长度不超过128个字节。
  • UTF8编码。
FileSize String文件大小。
Description String视频描述。
  • 长度不超过1024个字节。
  • UTF8编码。
CoverURL String自定义视频封面URL地址。
CateId String视频分类ID。可在 点播控制台 > 全局设置 > 分类管理 中编辑或查看分类的ID。
Tags String视频标签。
  • 单个标签不超过32字节,最多不超过16个标签。
  • 多个用逗号分隔。
  • UTF8编码。
TemplateGroupIdString转码模板组ID。
  • 可在 点播控制台 > 转码设置 里查看模版组ID。
  • 不为空时,会使用指定的模板组进行转码。
  • 会覆盖外层传入的TemplateGroupId。
WorkflowIdString工作流ID。
注意:如果同时传递了WorkflowId和TemplateGroupId,以WorkflowId为准。使用说明参考文档 工作流
FileExtensionString视频扩展名,支持的扩展名参见 上传概述 的限制部分。

注意:

  • UploadMetadata 中的参数(如Title、Description、Tags等)不能包含表情符。
  • 为确保正常播放,不转码即分发 模板组仅支持mp4、flv和m3u8格式的视频。若使用阿里云播放器,版本须为3.1.0或以上。
  • 指定不转码的模板组,视频上传后仅有 上传完成 事件通知,没有 转码完成 事件通知。
  • 上传完成后,除了上传和转码通知,还有 URL上传视频完成 事件通知。
  • 批量提交时,每一个SourceURL有独立的通知。

返回参数

名称类型描述
RequestIdString请求ID。
UploadJobsUploadJob[]多个Job信息。参考下表:UploadJob。

UploadJob

名称类型描述
JobIdString上传Job ID。
SourceURLString上传Job对应的URL。

注意:该接口为异步上传视频接口,任务将提交到上传队列排队,完成时间受已有任务数量影响。

API示例

请求示例

  1. http://vod.cn-shanghai.aliyuncs.com/?Action=CreateUploadVideo&Action=UploadMediaByURL&sourceURLs=http://xxxx&UploadMetadatas =[xxxx]&Format=JSON&<公共参数>

注意:示例中的“公共参数”参见 公共参数说明文档

返回示例

JSON格式

  1. {
  2. "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  3. "UploadJobs": [{
  4. "JobId": "ad90a501b1b94ba6afb72374ad005046",
  5. "SourceURL":"http://xxxxxx.mp4"
  6. },
  7. ...
  8. ]
  9. }

错误码

下表列举了本接口特有的错误码。视频点播通用的错误码信息,参见 错误码表

错误代码错误信息HTTP 状态码说明
InvalidParameter.UploadURLsThe specified parameter UploadURLs is not valid.400参数UploadURLs无效。

SDK示例

建议使用 服务端SDK 来调用API,此API各语言调用的示例代码,请参考如下: