UploadMediaByURL - URL拉取上传

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

接口说明

使用说明

  • 如果配置了回调,则上传完成后会收到URL上传视频完成的事件通知,可以通过获取URL上传信息接口查询上传状态。
  • 上传任务提交成功后,会在云端生成异步执行的任务,进行排队执行;上传完成后可根据事件通知(消息回调)返回的URL和视频ID等信息进行关联。
  • 本接口主要适用于文件没有存储在本地服务器或终端,需要通过公网访问的URL地址上传的场景。
  • 本接口目前仅支持华东2(上海)新加坡地域。

QPS限制

本接口的单用户QPS限制为200000次/天。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

调试

授权信息

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

请求参数

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

媒体源文件URL。

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

转码模板组ID。可通过以下方式获取:

  • 登录点播控制台,选择配置管理 > 媒体处理配置 > 转码模板组查看转码模版组ID。
  • 通过创建转码模板组接口创建转码模板组时,转码模板组ID为返回参数TranscodeTemplateGroupId的值。
  • 通过查询转码配置列表接口查询转码模板组时,为请求后返回参数TranscodeTemplateGroupId的值。
说明
  • 不设置转码模板组ID,则按默认的转码模板组进行转码;设置了转码模板组ID时,会使用该指定的模板组进行转码。
  • 可以在UploadMetadatas中进行设置,如果在UploadMetadatas中设置了TemplateGroupId,此处也设置了TemplateGroupId,则以UploadMetadatas中设置的TemplateGroupId为准。
  • ca3a8f6e4957b65806709586****
    StorageLocationstring

    媒体文件存储地址。

    登录点播控制台,选择配置管理 > 媒资管理配置 > 存储管理查看存储地址。不指定时会使用默认存储地址。

    outin-bfefbb90a47c******163e1c7426.oss-cn-shanghai.aliyuncs.com
    UploadMetadatasstring

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

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

    自定义设置。为JSON字符串,支持消息回调、上传加速等设置。更多信息,请参见UserData

    说明
  • 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用,否则回调设置不生效。控制台配置HTTP回调的操作,请参考回调设置
  • 上传加速功能在使用前请您提交工单开通,更多信息,请参见上传相关说明
  • 说明
  • 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用,否则回调设置不生效。控制台配置HTTP回调的操作,请参考回调设置
  • 上传加速功能在使用前请您提交工单开通,更多信息,请参见上传相关说明
  • {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}
    AppIdstring

    应用ID。默认取值:app-1000000。 更多信息,请参见多应用

    app-****
    WorkflowIdstring

    工作流ID。可登录点播控制台,选择配置管理 > 媒体处理配置 > 工作流管理查看工作流ID。

    说明如果同时传递了WorkflowId和TemplateGroupId,以WorkflowId为准。使用说明,请参见工作流
    e1e243b42548248197d6f74f9****

    UploadMetadata

    名称类型是否必需描述
    SourceURLString需要上传的媒体源文件URL。
    TitleString媒体标题。长度不超过128个字节。UTF-8编码。
    FileSizeString文件大小。
    DescriptionString描述。长度不超过1024个字节。UTF-8编码。
    CoverURLString自定义视频封面URL地址。
    CateIdString分类ID。可通过登录点播控制台,选择配置管理 > 媒资管理配置 > 分类管理查看分类ID。
    TagsString标签。单个标签不超过32字节,最多不超过16个标签。多个标签,请使用半角逗号(,)分隔。UTF8编码。
    TemplateGroupIdString转码模板组ID。会覆盖外层传入的TemplateGroupId。
    WorkflowIdString工作流ID。如果同时传入了WorkflowId和TemplateGroupId,以WorkflowId为准。更多信息,请参见工作流
    FileExtensionString媒体文件扩展名,支持的扩展名,请参见上传概述
    说明
  • UploadMetadata 中的参数(如Title、Description、Tags等)不能包含表情符。
  • 为确保正常播放,当TemplateGroupId设置为“VOD_NO_TRANSCODE”不转码的方式上传视频文件后,目前仅以下格式的文件支持不转码直接播放:MP4、FLV、MP3、M3U8、WEBM,其他格式仅支持存储(关注FileName的扩展名)。若使用阿里云播放器,版本须为3.1.0或以上。
  • 指定不转码的模板组(TemplateGroupId设置为“VOD_NO_TRANSCODE”),视频上传后仅有视频上传完成的事件通知,没有单个清晰度转码完成的事件通知。
  • 如果配置了回调,视频上传完成后,除了上传和转码通知,还有URL上传视频完成事件通知。
  • 批量提交时,每一个SourceURL有独立的通知。
  • 返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求ID。

    25818875-5F78-4AF6-D7393642CA58****
    UploadJobsarray

    多个Job信息。

    object

    上传任务详情。

    SourceURLstring

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

    http://example****.mp4
    JobIdstring

    上传任务ID。

    ad90a501b1b94fb72374ad005046****
    说明该接口为异步上传接口,任务将提交到上传队列排队,完成时间受已有任务数量影响。

    示例

    请求示例

    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.UploadURLsThe specified parameter UploadURLs is not valid.400参数UploadURLs无效。
    阿里云首页 视频点播 相关技术圈