调用CreateUploadVideo获取音视频上传地址和凭证_视频点播(VOD)-阿里云帮助中心

点播服务下发上传地址和凭证以保障授权和安全，防止恶意上传，并在下发时自动创建媒体ID（MediaId），也叫视频ID（VideoId）用于管理。通过调用本接口可获取上传所需地址和凭证，并创建音视频信息。

接口说明

请确保在使用该接口前，已充分了解视频点播产品的收费方式和价格。媒资文件上传到视频点播中会产生存储费用，计费详情，请参见媒资存储计费。如果您已开通了存储传输加速，则上传媒资文件到视频点播时还将涉及上传加速费用，计费详情请参见存储传输加速计费。
本接口既支持获取视频的上传地址和凭证，同时也支持获取音频的上传地址和凭证。具体操作，请参见上传地址和凭证。
本接口仅用于获取上传地址和凭证以及创建媒资基础信息，并非上传文件，通过接口上传的完整示例，请参见通过视频点播 API 上传媒资文件。
如果视频上传凭证失效（默认有效期为 3000 秒），请调用 RefreshUploadVideo 接口重新获取上传凭证。
上传后，可通过配置回调，接收上传事件通知或调用 GetMezzanineInfo 接口根据返回的文件状态来判断是否上传成功。
本接口返回的 VideoId 参数，可以用于媒资生命周期管理或媒体处理。
获取上传地址和凭证为点播服务的核心基础，是每个上传操作的必经过程。点播服务提供多种不同的上传方式，每种方式对获取上传地址和凭证的要求不同，详细内容请参见上传地址和凭证的使用说明。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vod:CreateUploadVideo	create	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
CoverURL	string	否	自定义视频封面的 URL 地址。	https://example.aliyundoc.com/image/D22F553TEST****.jpeg
Description	string	否	上传完成后，在点播中展示的音/视频描述。长度不超过 1024 个字符。 UTF-8 编码。	UploadTest
FileName	string	是	待上传的音/视频源文件地址。必须带扩展名，且扩展名不区分大小写。支持的扩展名，请参见上传概述。	D:\video_01.mp4
FileSize	long	否	待上传的音/视频源文件的大小。单位：字节。	123
Title	string	是	上传完成后，在点播中展示的音/视频标题。长度不超过 128 个字符。 UTF-8 编码。	UploadTest
CateId	long	否	分类 ID。可通过以下方式获取：登录点播控制台，选择配置管理 > 媒资管理配置 > 分类管理查看分类 ID。通过 AddCategory 接口创建分类时，分类 ID 为返回参数 CateId 的值。通过 GetCategories 接口查询分类时，为请求后返回参数 CateId 的值。	100036****
Tags	string	否	音/视频标签。最多不超过 16 个标签。如需设置多个音/视频标签，请使用半角逗号（,）分隔。单个标签不超过 32 个字符或汉字。 UTF-8 编码。	tag1,tag2
UserData	string	否	自定义设置。为 JSON 字符串，支持消息回调、上传加速等设置。更多信息，请参见 UserData 。说明此参数中消息回调的使用前提是需要在控制台配置 HTTP 回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。控制台配置 HTTP 回调的操作，请参考回调设置。如需使用上传加速功能，您需要填写宜搭信息申请开通，更多信息，请参见上传相关说明。	{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}}
TemplateGroupId	string	否	转码模板组 ID。可通过以下方式获取：登录点播控制台，选择配置管理 > 媒体处理配置 > 转码模板组查看转码模板组 ID。通过创建转码模板组接口创建转码模板组时，转码模板组 ID 为返回参数 TranscodeTemplateGroupId 的值。通过查询转码配置列表接口查询转码模板组时，为请求后返回参数 TranscodeTemplateGroupId 的值。说明如果同时传递了 WorkflowId 和 TemplateGroupId，以 WorkflowId 为准。若不传入本参数，则按默认的转码模板组进行转码；若传入了转码模板组 ID 时，则按指定的模板组进行转码。若设置为系统内置的不转码模板组，则音视频上传后，仅有视频上传完成的事件通知，没有单个清晰度转码完成的事件通知。为确保正常播放，当设置为系统内置的不转码模板组，则视音频上传完成后，仅以下格式支持不转码直接播放：MP4、FLV、MP3、M3U8、WEBM，其他格式仅支持存储（关注 FileName 的扩展名）；若使用阿里云播放器播放，则版本须为 3.1.0 或以上。	405477f9e214d19ea2c7c854****
WorkflowId	string	否	工作流 ID。可登录点播控制台，选择配置管理 > 媒体处理配置 > 工作流管理查看工作流 ID。说明如果同时传递了 WorkflowId 和 TemplateGroupId，以 WorkflowId 为准。使用说明，请参见工作流。	613efff3887ec34af685714cc461****
StorageLocation	string	否	存储地址。可通过以下方式获取：登录点播控制台，选择配置管理 > 媒资管理配置 > 存储管理查看存储地址。说明若不传此参数，则音视频文件上传到默认的存储地址上；若传入此参数，则音视频文件上传到该指定的存储地址上。	out-****.oss-cn-shanghai.aliyuncs.com
AppId	string	否	应用 ID。默认取值：app-1000000。更多信息，请参见多应用。	app-1000000

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	25818875-5F78-4AF6-04D5-D7393642****
UploadAddress	string	上传地址。说明接口返回的上传地址是 Base64 加密后的值。调用 SDK 或 API 完成媒资上传时需要对其进行 Base64 解码后再使用。仅 OSS 原生 SDK 或 OSS API 方式上传需要自行解析 UploadAddress。	eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****
VideoId	string	音/视频 ID。可作为媒资管理、媒体处理、媒体审核等接口的请求参数。	93ab850b4f6f54b6e91d24d81d44****
UploadAuth	string	上传凭证。说明接口返回的上传凭证是 Base64 加密后的值。调用 SDK 或 API 完成媒资上传时需要对其进行 Base64 解码后再使用。仅 OSS 原生 SDK 或 OSS API 方式上传需要自行解析 UploadAuth。	eyJFbmRwb2ludCI6Imm****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史

接口错误码

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

错误代码	错误信息	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	创建视频信息失败，请稍后重试。