文档

UploadMediaByURL - URL拉取上传

更新时间:

调用UploadMediaByURL基于源文件URL,拉取音视频媒体文件进行上传,支持批量上传。

接口说明

  • 如果配置了回调,则上传完成后会收到 URL 上传视频完成的事件通知,可以通过获取 URL 上传信息接口查询上传状态。
  • 上传任务提交成功后,会在云端生成异步执行的任务,进行排队执行;上传完成后可根据事件通知(消息回调)返回的 URL 和视频 ID 等信息进行关联。
  • 本接口主要适用于文件没有存储在本地服务器或终端,需要通过公网访问的 URL 地址上传的场景。
  • 本接口仅支持上传至 VOD 点播存储,不支持上传至用户自有 OSS 存储。使用自有 OSS 存储的用户,可以先将文件拉取到本地,通过OSS SDK上传文件至 OSS,然后再调用 RegisterMediaInfo 接口将 OSS 文件注册至媒资库。
  • 本接口目前仅支持华东 2(上海)、华北 2(北京)、华南 1(深圳)地域。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
UploadURLsstring

媒体源文件 URL。

  • URL 中需要包括扩展名, 比如https://****.mp4中 mp4 为扩展名。
    • 如果 URL 中不包含扩展名,可以在UploadMetadatas中传入FileExtension来指定。
    • 如果 URL 中有扩展名且同时传入FileExtension,以传入的FileExtension为准。
  • URL 编码,多个地址之间以半角逗号(,)分隔,最多支持 20 个。
  • 避免存在特殊字符导致无法上传视频,需要 URL 编码后再做逗号拼接。
https://diffurl.mp4
AppIdstring

应用 ID。

app-1000000
UserDatastring

自定义设置。为 JSON 字符串,支持消息回调等设置。

{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}
UploadTargetConfigstring

目标存储地址。

StorageType 取值:仅支持 oss。

StorageLocation 仅支持 VOD 点播存储,不支持用户自有 OSS 存储。

{"StorageType":"oss","StorageLocation":"outin-***.oss-cn-shanghai.aliyuncs.com"}
MediaMetaDatastring

上传媒体文件的元数据信息,为 JSON 字符串。

  • 与 UploadURLs 里的 URL 匹配才能生效。
  • JSON 格式:[UploadMetadata, UploadMetadata,…],需转为 JSON 字符串 。
  • 更多信息,请参见下表 UploadMetadata。
[{"SourceURL":"https://example.aliyundoc.com/video01.mp4","Title":"urlUploadTest"}]
PostProcessConfigstring

Type = video || audio 有上传后处理动作。

ProcessType 取值:Workflow。

{"ProcessType": "Workflow","ProcessID":"b72a06c6beeb4dcdb898feef067b1***"}
EntityIdstring

实体 ID。可调用 CreateEntity 接口创建实体,自定义动态元数据结构。

d67281da3c8743b8823ad12976187***

UploadMetadata

名称类型是否必需描述
SourceURLString需要上传的媒体源文件 URL。
TitleString媒体标题。长度不超过 128 个字节。UTF-8 编码。
FileSizeString文件大小。
DescriptionString描述。长度不超过 1024 个字节。UTF-8 编码。
CoverURLString自定义视频封面 URL 地址。
CateIdString分类 ID。
TagsString标签。单个标签不超过 32 字节,最多不超过 16 个标签。多个标签,请使用半角逗号(,)分隔。UTF8 编码。
WorkflowIdString工作流 ID。
FileExtensionString媒体文件扩展名。
DynamicMetaDataString动态元数据,例:"{"Uploader": "xxx"}"。
FileExtensionString实体 Id。
说明
  • UploadMetadata 中的参数(如 Title、Description、Tags 等)不能包含表情符。
  • 如果配置了回调,视频上传完成后,除了上传和转码通知,还有 URL 上传视频完成件通知。
  • 批量提交时,每一个 SourceURL 有独立的通知。
  • 返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    ****83B7-7F87-4792-BFE9-63CD2137****
    UploadJobsobject []

    多个 Job 信息。

    JobIdstring

    上传任务 ID。

    20ce1e05dba64576b96e9683879f0***
    SourceURLstring

    上传任务对应的源文件 URL。

    http://example****.mp4
    MediaIdstring

    媒资 ID。

    f476988629f54a7b8a4ba90d1a6c7***

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "****83B7-7F87-4792-BFE9-63CD2137****",
      "UploadJobs": [
        {
          "JobId": "20ce1e05dba64576b96e9683879f0***",
          "SourceURL": "http://example****.mp4\n",
          "MediaId": "f476988629f54a7b8a4ba90d1a6c7***"
        }
      ]
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)
    文档反馈