UploadStreamByURL - 通过URL上传转码流

上传外部存储的转码流文件并挂载到对应的点播媒资下。

接口说明

  • 请确保在使用该接口前,已充分了解视频点播产品的收费方式和价格。媒资文件上传到视频点播中会产生存储费用,计费详情,请参见媒资存储计费。如果您已开通了存储传输加速,则上传媒资文件到视频点播时还将涉及上传加速费用,计费详情请参见存储传输加速计费
  • 该接口目前仅支持上海新加坡地域使用。
  • 调用本接口上传外部存储的转码流文件并挂载到对应的点播媒资下。本接口支持的转码流 HDR 类型为 HDR、HDR10、HLG、DolbyVision、HDRVivid 和 SDR+类型。
  • 您可以通过获取 URL 上传信息接口来查询上传状态,上传完成后会收到 URL 上传转码流完成的事件通知。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:UploadStreamByURL
  • 全部资源
    *

请求参数

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

转码流文件 URL。

如果转码流的 URL 需要鉴权,需要在 StreamURL 中传入鉴权参数,并确保该 URL 可以通过公网访问。

说明 URL 可以通过控制台获取音视频的地址;也可以通过 getplayinfo 接口调用来获取音视频地址。
https://example.com/lesson-01.mp4
MediaIdstring

转码流对应的点播媒资 ID。

ca3a8f6e49*****57b65806709586
Definitionstring

视频流清晰度。

取值,详情请参考: 媒资参数说明-清晰度

HD
FileExtensionstring

转码流文件扩展名。

扩展名请参见概述中的音频和视频的支持文件格式。

当该参数不为空时,会覆盖 StreamURL 地址中的文件扩展名。

注意 若 StreamURL 地址中不含文件扩展名,该参数必填。

mp4
HDRTypestring

转码流 HDR 类型。取值:

  • HDR
  • HDR10
  • HLG
  • DolbyVision
  • HDRVivid
  • SDR+
说明
  • 大小写不敏感。
  • 非 HDR 视频该参数为空即可。
  • HDR10
    UserDatastring

    用户自定义参数。详情参见 UserData

    说明 此参数中消息回调的使用前提是需要在控制台配置 HTTP 回调地址和勾选对应的回调事件类型才能使用,否则回调设置不生效。控制台配置 HTTP 回调的操作,请参考回调设置
    {"MessageCallback":{"CallbackURL":"http://aliyundoc.com"}, "Extend":{"localId":"xxx","test":"www"}}

    返回参数

    名称类型描述示例值
    object

    基本信息。

    RequestIdstring

    请求 ID。

    7AE96389-DF1E-598D-816B-7B40F13B4620
    StreamJobIdstring

    转码流 JobId。可以作为 GetURLUploadInfos 接口的请求参数。

    点播使用 JobId 唯一标识一个转码流文件。详情请参考:基本数据-PlayInfo 视频播放信息

    e304b34fb3d959f92baef97b6496****
    FileURLstring

    转码流 OSS 文件地址。

    http://outin-31059bcee7810a200163e1c8dba****.oss-cn-shanghai.aliyuncs.com/lesson-01.mp4
    SourceURLstring

    转码流输入 URL 地址。可以作为 GetURLUploadInfos 接口的请求参数。

    https://example.com/lesson-01.mp4

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "7AE96389-DF1E-598D-816B-7B40F13B4620",
      "StreamJobId": "e304b34fb3d959f92baef97b6496****",
      "FileURL": "http://outin-31059bcee7810a200163e1c8dba****.oss-cn-shanghai.aliyuncs.com/lesson-01.mp4",
      "SourceURL": "https://example.com/lesson-01.mp4"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2021-12-22OpenAPI 返回结构发生变更查看变更详情
    2021-12-20OpenAPI 返回结构发生变更查看变更详情
    2021-11-16OpenAPI 入参发生变更查看变更详情
    2021-10-28新增 OpenAPI查看变更详情