调用CreateUploadAttachedMedia获取辅助媒资上传地址和凭证,辅助媒资包括水印、字幕、素材等。

使用说明

  • 获取上传地址和凭证为点播服务的核心基础,是每个上传操作的必经过程。点播服务提供了服务端上传SDK、客户端上传SDK、离线拉取上传、基于OSS服务端API上传、基于OSS原生SDK上传等不同的上传方式,每种方式对获取上传地址和凭证的要求不同,详细内容请参见上传地址和凭证的使用说明。
  • 如果上传凭证失效(有效期3000秒),请重新调用此接口获取上传地址和凭证。
  • 可通过配置回调,接收辅助媒资上传完成的事件通知来判断是否上传成功。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateUploadAttachedMedia

系统规定参数。取值:CreateUploadAttachedMedia

Title String 测试

标题。规则:

  • 长度不超过128个字节。
  • UTF8编码。
BusinessType String watermark

业务类型。取值:

  • watermark:水印。
  • subtitle:字幕。
  • material:素材。
MediaExt String png

文件扩展名。取值:

  • 水印:png、gif、apng、mov
  • 字幕:srt、ass、stl、ttml、vtt
  • 素材:jpg、gif、png、mp4、mat、zip
FileName String D:\test.png

源文件名。

FileSize String 123

文件大小。单位:字节。

Tags String tag1,tag2

标签。规则:

  • 最多不超过16个标签。
  • 如需设置多个标签,请使用半角逗号(,)分隔。
  • 单个标签不超过32个字符或汉字。
  • UTF-8编码。
StorageLocation String out-****.oss-cn-shanghai.aliyuncs.com

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

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

说明 当地址不为空时,会使用该指定的存储地址上传辅助媒资文件。
Description String uploadTest

媒资描述。规则:

  • 长度不超过1024个字节。
  • UTF-8编码。
UserData String {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}

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

说明
  • 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用,否则回调设置不生效。控制台配置HTTP回调的操作,请参考回调设置

  • 上传加速功能在使用前请您提交工单开通,更多信息,请参见上传相关说明

CateIds String 1298****,0813****

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

  • 登录点播控制台,选择配置管理 > 媒资管理配置 > 分类管理查看分类ID。
  • 通过创建分类接口创建分类时,分类ID为返回参数CateId的值。
  • 通过获取分类及子分类接口查询分类时,为请求后返回参数CateId的值。
AppId String app-****

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

返回数据

名称 类型 示例值 描述
FileURL String https://****.oss-cn-shanghai.aliyuncs.com/watermark/****.mov

文件OSS地址(不带鉴权)。添加水印时该地址可做为添加水印接口的入参FileUrl。

RequestId String 73254DE5-F260-4720-D06856B63C01****

请求ID。

UploadAddress String LWNuLXNoYW5naGFpLmFsaXl1b****

上传地址。

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

媒资ID。

MediaURL String http://example.aliyundoc.com/watermark/****.mov?auth_key=****

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

说明 如果返回的MediaURL在浏览器无法访问(403),是因为您开启了点播域名的鉴权功能。可关闭URL鉴权或自助生成鉴权签名
UploadAuth String UzFnUjFxNkZ0NUIZTaklyNWJoQ00zdHF****

上传凭证。

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

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=CreateUploadAttachedMedia
&Title=测试
&BusinessType=watermark
&MediaExt=png
&FileName=D:\test.png
&FileSize=123
&Tags=tag1,tag2
&StorageLocation=out-****.oss-cn-shanghai.aliyuncs.com
&Description=uploadTest
&UserData={"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}
&CateIds=1298****,0813****
&AppId=app-****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateUploadAttachedMediaResponse>
    <FileURL>https://****.oss-cn-shanghai.aliyuncs.com/watermark/****.mov</FileURL>
    <RequestId>73254DE5-F260-4720-D06856B63C01****</RequestId>
    <UploadAddress>LWNuLXNoYW5naGFpLmFsaXl1b****</UploadAddress>
    <MediaId>97dc17a5abc3668489b84ce9****</MediaId>
    <MediaURL>http://example.aliyundoc.com/watermark/****.mov?auth_key=****</MediaURL>
    <UploadAuth>UzFnUjFxNkZ0NUI*****ZTaklyNWJoQ00zdHF</UploadAuth>
</CreateUploadAttachedMediaResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : "UzFnUjFxNkZ0NUI*****ZTaklyNWJoQ00zdHF"
}

错误码

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

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: