调用CreateUploadVideo获取视频上传地址和凭证,并创建视频信息。

使用说明

  • 此接口同时支持获取音频的上传地址和凭证。具体操作,请参见上传地址和凭证
  • 获取上传地址和凭证为点播服务的核心基础,是每个上传操作的必经过程。点播服务提供了客户端SDK上传、API上传、基于OSS原生SDK上传等不同的上传方式,每种方式对获取上传地址和凭证的要求不同,详细内容请参见上传地址和凭证的使用说明。
  • 如果视频上传凭证失效(默认有效期为3000秒),请调用刷新视频上传凭证接口重新获取上传凭证。

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:CreateUploadVideo

CoverURL String https://example.aliyundoc.com/image/D22F553TEST****.jpeg

自定义视频封面的URL地址。

Description String UploadTest

视频描述。

  • 长度不超过1024个字符。
  • UTF-8编码。
FileName String D:\video_01.mp4

视频源文件名。

  • 必须带扩展名,且扩展名不区分大小写。
  • 支持的扩展名,请参见上传概述
FileSize Long 123

视频文件大小。单位:字节。

Title String UploadTest

视频标题。

  • 长度不超过128个字符。
  • UTF-8编码。
CateId Long 100036****

视频分类ID。可通过以下方式获取:

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

视频标签。

  • 最多不超过16个标签。
  • 如需设置多个视频标签,请使用半角逗号(,)分隔。
  • 单个标签不超过32个字符或汉字。
  • UTF-8编码。
UserData String {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}

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

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

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

TemplateGroupId String 405477f9e214d19ea2c7c854****

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

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

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

说明 如果同时传递了WorkflowId和TemplateGroupId,以WorkflowId为准。使用说明,请参见工作流
StorageLocation String out-****.oss-cn-shanghai.aliyuncs.com

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

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

说明 当地址不为空时,会使用该指定的存储地址上传视频文件。
AppId String app-1000000

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

说明
  • 为确保正常播放,当转码模板组选择为“不转码”的方式上传视频文件后,点播播放服务仅支持MP4、FLV、MP3和M3U8格式的视频,其他格式仅支持存储(关注FileName的扩展名);若使用阿里云播放器,版本须为3.1.0或以上。
  • 指定不转码的模板组,视频上传后仅有上传完成的事件通知,没有转码完成事件通知。

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-4AF6-04D5-D7393642****

请求ID。

UploadAddress String eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****

上传地址。

说明 接口返回的上传地址是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。解码的详细操作请参见上传地址和凭证的解析上传地址和凭证。
VideoId String 93ab850b4f6f54b6e91d24d81d44****

音/视频ID。可作为媒资管理、媒体处理、媒体审核等接口的请求参数。

UploadAuth String eyJFbmRwb2ludCI6Imm****

上传凭证。

说明 接口返回的上传凭证是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。解码的详细操作请参见上传地址和凭证的解析上传地址和凭证。

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=CreateUploadVideo
&CoverURL=https://example.aliyundoc.com/image/D22F553TEST****.jpeg
&Description=UploadTest
&FileName=D:\video_01.mp4
&FileSize=123
&Title=UploadTest
&CateId=1000369573
&Tags=tag1,tag2
&UserData={"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}
&TemplateGroupId=405477f9e214d19ea2c7c854****
&WorkflowId=613efff3887ec34af685714cc461****
&StorageLocation=out-****.oss-cn-shanghai.aliyuncs.com
&AppId=app-****
&公共请求参数

正常返回示例

XML格式

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

<CreateUploadVideoResponse>
    <RequestId>25818875-5F78-4AF6-04D5-D7393642****</RequestId>
    <UploadAddress>eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****</UploadAddress>
    <VideoId>93ab850b4f6f54b6e91d24d81d44****</VideoId>
    <UploadAuth>eyJFbmRw*****b2ludCI6Im</UploadAuth>
</CreateUploadVideoResponse>

JSON格式

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

{
  "RequestId" : "25818875-5F78-4AF6-04D5-D7393642****",
  "UploadAddress" : "eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****",
  "VideoId" : "93ab850b4f6f54b6e91d24d81d44****",
  "UploadAuth" : "eyJFbmRw*****b2ludCI6Im"
}

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码

错误信息

HTTP 状态码

说明

InvalidFileName.Extension

The specified FileName’s extension is illegal.

400

参数FileName的文件扩展名无效。点播支持的文件扩展名限制,请参见上传概述

IllegalCharacters

The specified $Parameter contains illegal emoticon or special characters.

400

请求参数Parameter(如:Title、Description、Tags等)参数值中不能包含表情符。

LengthExceededMax

The specified $Parameter length has exceeded $MaxLength bytes.

400

请求参数Parameter(如:Title、Description、Tags)参数值长度超过MaxLength限制。参数值长度限制请参考本文档中请求参数说明。

TagsExceededMax

The specified Tags count has exceeded 16.

400

设置的标签个数超过最多16个的限制。

InvalidTemplateGroupId.NotFound

The TemplateGroupId does not exist.

404

指定的模板组ID不存在。

InvalidStorage.NotFound

The StorageLocation does not exist.

404

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

Forbidden.InitFailed

Initialization of your account has failed while opening service.

403

服务开通时账号初始化失败。

AddVideoFailed

Adding video has failed due to some unknown error.

503

创建视频信息失败,请稍后重试。

SDK示例

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