调用UploadMediaByURL基于源文件URL,拉取音视频媒体文件进行上传,支持批量上传。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
UploadURLs | string | 是 | 媒体源文件URL。
| https://****.mp4 |
TemplateGroupId | string | 否 | 转码模板组ID。可通过以下方式获取:
说明 UploadMetadatas 中进行设置,如果在UploadMetadatas中设置了TemplateGroupId,此处也设置了TemplateGroupId,则以UploadMetadatas中设置的TemplateGroupId为准。 | ca3a8f6e4957b65806709586**** |
StorageLocation | string | 否 | 媒体文件存储地址。 登录点播控制台,选择配置管理 > 媒资管理配置 > 存储管理查看存储地址。不指定时会使用默认存储地址。 | outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com |
UploadMetadatas | string | 否 | 上传媒体文件的元数据信息,为JSON字符串。
| [{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}] |
UserData | string | 否 | {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}} | |
AppId | string | 否 | 应用ID。默认取值:app-1000000。 更多信息,请参见多应用。 | app-**** |
WorkflowId | string | 否 | e1e243b42548248197d6f74f9**** |
UploadMetadata
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
SourceURL | String | 是 | 需要上传的媒体源文件URL。 |
Title | String | 是 | 媒体标题。长度不超过128个字节。UTF-8编码。 |
FileSize | String | 否 | 文件大小。 |
Description | String | 否 | 描述。长度不超过1024个字节。UTF-8编码。 |
CoverURL | String | 否 | 自定义视频封面URL地址。 |
CateId | String | 否 | 分类ID。可通过登录点播控制台,选择配置管理 > 媒资管理配置 > 分类管理查看分类ID。 |
Tags | String | 否 | 标签。单个标签不超过32字节,最多不超过16个标签。多个标签,请使用半角逗号(,)分隔。UTF8编码。 |
TemplateGroupId | String | 否 | 转码模板组ID。会覆盖外层传入的TemplateGroupId。 |
WorkflowId | String | 否 | 工作流ID。如果同时传入了WorkflowId和TemplateGroupId,以WorkflowId为准。更多信息,请参见工作流。 |
FileExtension | String | 否 | 媒体文件扩展名,支持的扩展名,请参见上传概述。 |
说明UploadMetadata 中的参数(如Title、Description、Tags等)不能包含表情符。 为确保正常播放,当TemplateGroupId设置为“VOD_NO_TRANSCODE”不转码的方式上传视频文件后,目前仅以下格式的文件支持不转码直接播放:MP4、FLV、MP3、M3U8、WEBM,其他格式仅支持存储(关注FileName的扩展名)。若使用阿里云播放器,版本须为3.1.0或以上。 指定不转码的模板组(TemplateGroupId设置为“VOD_NO_TRANSCODE”),视频上传后仅有视频上传完成的事件通知,没有单个清晰度转码完成的事件通知。 如果配置了回调,视频上传完成后,除了上传和转码通知,还有URL上传视频完成事件通知。 批量提交时,每一个SourceURL有独立的通知。
返回参数
说明该接口为异步上传接口,任务将提交到上传队列排队,完成时间受已有任务数量影响。
示例
请求示例
http(s)://vod.cn-shanghai.aliyuncs.com/?Action=UploadMediaByURL
&UploadURLs=https://example****.mp4
&TemplateGroupId=ca3a8f6e4957b65806709586****
&StorageLocation=outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
&UploadMetadatas=[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}]
&UserData={"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}
&AppId=app-****
&WorkflowId=e1e243b42548248197d6f74f9****
&公共请求参数
正常返回示例
JSON
格式
{
"RequestId": "25818875-5F78-4AF6-D7393642CA58****",
"UploadJobs": [
{
"SourceURL": "http://example****.mp4",
"JobId": "ad90a501b1b94fb72374ad005046****"
}
]
}
XML
格式
<UploadMediaByURLResponse>
<RequestId>25818875-5F78-4AF6-D7393642CA58****</RequestId>
<UploadJobs>
<SourceURL>http://example****.mp4</SourceURL>
<JobId>ad90a501b1b94fb72374ad005046****</JobId>
</UploadJobs>
</UploadMediaByURLResponse>
错误码
访问错误中心查看更多错误码。
接口错误码
下表列举了本接口特有的错误码。
错误代码 | 错误信息 | HTTP 状态码 | 说明 |
---|---|---|---|
InvalidParameter.UploadURLs | The specified parameter UploadURLs is not valid. | 400 | 参数UploadURLs无效。 |