调用UploadMediaByURL基于源文件URL,拉取音视频媒体文件进行上传,支持批量上传。本接口主要适用于文件没有存储在本地服务器或终端,需要通过公网访问的URL地址上传的场景。
接口说明
接口说明
如果配置了回调,则上传完成后会收到 URL 上传视频完成的事件通知,可以通过获取 URL 上传信息接口查询上传状态。
上传任务提交成功后,会在云端生成异步执行的任务,进行排队执行;上传完成后可根据事件通知(消息回调)返回的 URL 和视频 ID 等信息进行关联。
使用限制
-
本接口仅支持上传至 VOD 点播存储,不支持上传至用户自有 OSS 存储。使用自有 OSS 存储的用户,可以先将文件拉取到本地,通过OSS SDK上传文件至 OSS,然后再调用 RegisterMediaInfo 接口将 OSS 文件注册至媒资库。
-
本接口目前仅支持华东 2(上海)、华北 2(北京)、华南 1(深圳)地域。
-
本接口仅支持上传音视频文件。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ice:UploadMediaByURL |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| UploadURLs |
string |
否 |
媒体源文件 URL。
|
https://diffurl.mp4 |
| AppId |
string |
否 |
应用 ID。 |
app-1000000 |
| UserData |
string |
否 |
自定义设置。为 JSON 字符串,支持消息回调等设置。 |
{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}} |
| UploadTargetConfig |
string |
否 |
目标存储地址。
|
{"StorageType":"oss","StorageLocation":"outin-***.oss-cn-shanghai.aliyuncs.com"} |
| MediaMetaData |
string |
否 |
上传媒体文件的元数据信息,为 JSON 字符串。
|
[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}] |
| PostProcessConfig |
string |
否 |
Type = video || audio 有上传后处理动作。 ProcessType 取值:Workflow。 |
{"ProcessType": "Workflow","ProcessID":"b72a06c6beeb4dcdb898feef067b1***"} |
| EntityId |
string |
否 |
实体 ID。可调用 CreateEntity 接口创建实体,自定义动态元数据结构。 |
d67281da3c8743b8823ad12976187*** |
UploadMetadata
| 名称 | 类型 | 是否必需 | 描述 |
| SourceURL | String | 是 | 需要上传的媒体源文件 URL。 |
| Title | String | 是 | 媒体标题。长度不超过 128 个字节。UTF-8 编码。 |
| FileSize | String | 否 | 文件大小。 |
| Description | String | 否 | 描述。长度不超过 1024 个字节。UTF-8 编码。 |
| CoverURL | String | 否 | 自定义视频封面 URL 地址。 |
| CateId | String | 否 | 分类 ID。 |
| Tags | String | 否 | 标签。单个标签不超过 32 字节,最多不超过 16 个标签。多个标签,请使用半角逗号(,)分隔。UTF8 编码。 |
| WorkflowId | String | 否 | 工作流 ID。 |
| FileExtension | String | 否 | 媒体文件扩展名。 |
| DynamicMetaData | String | 否 | 动态元数据,例:"{"Uploader": "xxx"}"。 |
| EntityId | String | 否 | 实体 Id。 |
WorkflowId 参数任务为异步任务,提交后任务尚未完成,任务将进入后台排队异步执行。
UploadMetadata 中的参数(如 Title、Description、Tags 等)不能包含表情符。
如果配置了回调,视频上传完成后,除了上传和转码通知,还有 URL 上传视频完成件通知。
批量提交时,每一个 SourceURL 有独立的通知。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。 |
****83B7-7F87-4792-BFE9-63CD2137**** |
| UploadJobs |
array<object> |
多个 Job 信息。 |
|
|
object |
上传任务详情。 |
||
| JobId |
string |
上传任务 ID。 |
20ce1e05dba64576b96e9683879f0*** |
| SourceURL |
string |
上传任务对应的源文件 URL。 |
http://example****.mp4 |
| MediaId |
string |
媒资 ID。 |
f476988629f54a7b8a4ba90d1a6c7*** |
示例
正常返回示例
JSON格式
{
"RequestId": "****83B7-7F87-4792-BFE9-63CD2137****",
"UploadJobs": [
{
"JobId": "20ce1e05dba64576b96e9683879f0***",
"SourceURL": "http://example****.mp4\n",
"MediaId": "f476988629f54a7b8a4ba90d1a6c7***"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。