文档

CreateUploadAttachedMedia - 获取辅助媒资上传地址和凭证

上传地址和上传凭证均由点播服务下发,主要解决媒体上传过程中的授权和安全问题,防止恶意上传。同时,点播服务在下发上传地址和凭证时还会自动创建媒资信息,即媒资ID(MediaId),用于媒资生命周期管理或媒体处理。辅助媒资包括水印图片、字幕文件、其他素材,调用CreateUploadAttachedMedia获取辅助媒资上传地址和凭证,并创建辅助媒资信息。

接口说明

  • 请确保在使用该接口前,已充分了解视频点播产品的收费方式和价格。媒资文件上传到视频点播中会产生存储费用,计费详情,请参见媒资存储计费。如果您已开通了存储传输加速,则上传媒资文件到视频点播时还将涉及上传加速费用,计费详情请参见存储传输加速计费
  • 本接口仅用于获取上传地址和凭证以及创建媒资基础信息,并非上传文件,通过接口上传的完整示例,请参见通过视频点播 API 上传媒资文件
  • 如果上传凭证失效(有效期 3000 秒),请重新调用此接口获取上传地址和凭证。
  • 可通过配置回调,接收辅助媒资上传完成的事件通知来判断是否上传成功。
  • 获取上传地址和凭证为点播服务的核心基础,是每个上传操作的必经过程。点播服务提供多种不同的上传方式,每种方式对获取上传地址和凭证的要求不同,详细内容请参见上传地址和凭证的使用说明。

调试

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

授权信息

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

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

请求参数

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

辅助媒资的标题。规则:

  • 长度不超过 128 个字节。
  • UTF8 编码。
测试
BusinessTypestring

辅助媒资的类型。取值:

  • watermark:水印。
  • subtitle:字幕。
  • material:素材。
watermark
MediaExtstring

待上传的辅助媒资源文件的扩展名。取值:

  • 水印:png、gif、apng、mov
  • 字幕:srt、ass、stl、ttml、vtt
  • 素材:jpg、gif、png、mp4、mat、zip、apk
png
FileNamestring

待上传的辅助媒资的源文件地址。

说明 可不带扩展名;若此处带了扩展名,且此处的扩展名与 MediaExt 中设置的扩展名不一致,以 MediaExt 为准。
D:\test.png
FileSizestring

文件大小。单位:字节。

123
Tagsstring

标签。规则:

  • 最多不超过 16 个标签。
  • 如需设置多个标签,请使用半角逗号(,)分隔。
  • 单个标签不超过 32 个字符或汉字。
  • UTF-8 编码。
tag1,tag2
StorageLocationstring

存储地址。可通过以下方式获取:

登录点播控制台,选择配置管理 > 媒资管理配置 > 存储管理查看存储地址。

说明 若不传此参数,则辅助媒资上传到默认的存储地址上;若传入此参数,则辅助媒资上传到该指定的存储地址上。
out-****.oss-cn-shanghai.aliyuncs.com
Descriptionstring

媒资描述。规则:

  • 长度不超过 1024 个字节。
  • UTF-8 编码。
uploadTest
UserDatastring

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

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

    分类 ID。多个 ID 之间使用半角逗号(,)分隔。最多支持 5 个。可通过以下方式获取:

    • 登录点播控制台,选择配置管理 > 媒资管理配置 > 分类管理查看分类 ID。
    • 调用 AddCategory 接口创建分类时会返回。
    • 调用 GetCategories 接口查询分类时会返回。
    1298****,0813****
    AppIdstring

    应用 ID。默认取值:app-1000000。若已开通多应用体系,传入应用 ID,可将辅助媒资上传到指定应用下。更多信息,请参见多应用

    app-****

    返回参数

    名称类型描述示例值
    object

    返回结果。

    FileURLstring

    辅助媒资文件的 OSS 地址(不带鉴权)。

    添加图片水印模板时,该地址可做为 AddWatermark 接口的请求参数FileUrl

    https://****.oss-cn-shanghai.aliyuncs.com/watermark/****.mov
    RequestIdstring

    请求 ID。

    73254DE5-F260-4720-D06856B63C01****
    UploadAddressstring

    上传地址。

    说明 接口返回的上传地址是 Base64 加密后的值。调用 SDK 或 API 完成媒资上传时需要对其进行 Base64 解码后再使用。仅 OSS 原生 SDK 或 OSS API 方式上传需要自行解析 UploadAddress。
    LWNuLXNoYW5naGFpLmFsaXl1b****
    MediaIdstring

    媒资 ID。

    97dc17a5abc3668489b84ce9****
    MediaURLstring

    媒资的访问地址。

    如果配置了 CDN 域名则返回 CDN 地址,否则为 OSS 地址。

    说明 如果返回的 MediaURL 在浏览器无法访问(403),是因为您开启了点播域名的鉴权功能。可关闭 URL 鉴权或自助生成鉴权签名
    http://example.aliyundoc.com/watermark/****.mov?auth_key=****
    UploadAuthstring

    上传凭证。

    说明 接口返回的上传凭证是 Base64 加密后的值。调用 SDK 或 API 完成媒资上传时需要对其进行 Base64 解码后再使用。仅 OSS 原生 SDK 或 OSS API 方式上传需要自行解析 UploadAuth。
    UzFnUjFxNkZ0NUIZTaklyNWJoQ00zdHF****

    示例

    正常返回示例

    JSON格式

    {
      "FileURL": "https://****.oss-cn-shanghai.aliyuncs.com/watermark/****.mov",
      "RequestId": "73254DE5-F260-4720-D06856B63C01****",
      "UploadAddress": "LWNuLXNoYW5naGFpLmFsaXl1b****",
      "MediaId": "97dc17a5abc3668489b84ce9****",
      "MediaURL": "http://example.aliyundoc.com/watermark/****.mov?auth_key=****",
      "UploadAuth": "UzFnUjFxNkZ0NUIZTaklyNWJoQ00zdHF****"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史