调用CreateUploadVideo获取音视频上传地址和凭证,并创建音视频信息。
使用说明
- 此接口既支持获取视频的上传地址和凭证,同时也支持获取音频的上传地址和凭证。具体操作,请参见上传地址和凭证。
- 获取上传地址和凭证为点播服务的核心基础,是每个上传操作的必经过程。点播服务提供了服务端上传SDK、客户端上传SDK、离线拉取上传、基于OSS服务端API上传、基于OSS原生SDK上传等不同的上传方式,每种方式对获取上传地址和凭证的要求不同,详细内容请参见上传地址和凭证的使用说明。
- 如果视频上传凭证失效(默认有效期为3000秒),请调用刷新视频上传凭证接口重新获取上传凭证。
- 上传后,可通过配置回调,接收上传事件通知或调用GetMezzanineInfo接口根据返回的文件状态来判断是否上传成功。
- 本接口返回的VideoId参数,可以用于媒资生命周期管理或媒体处理。
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 |
音/视频描述。
|
FileName | String | 是 | D:\video_01.mp4 |
音/视频源文件名。
|
FileSize | Long | 否 | 123 |
音/视频文件大小。单位:字节。 |
Title | String | 是 | UploadTest |
音/视频标题。
|
CateId | Long | 否 | 100036**** |
分类ID。可通过以下方式获取: |
Tags | String | 否 | tag1,tag2 |
音/视频标签。
|
UserData | String | 否 | {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}} |
自定义设置。为JSON字符串,支持消息回调、上传加速等设置。更多信息,请参见UserData。 |
TemplateGroupId | String | 否 | 405477f9e214d19ea2c7c854**** |
转码模板组ID。可通过以下方式获取:
说明 不设置转码模板组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。更多信息,请参见多应用。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 25818875-5F78-4AF6-04D5-D7393642**** |
请求ID。 |
UploadAddress | String | eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF**** |
上传地址。 说明 接口返回的上传地址是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAddress。
|
VideoId | String | 93ab850b4f6f54b6e91d24d81d44**** |
音/视频ID。可作为媒资管理、媒体处理、媒体审核等接口的请求参数。 |
UploadAuth | String | eyJFbmRwb2ludCI6Imm**** |
上传凭证。 说明 接口返回的上传凭证是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。仅OSS原生SDK或OSS API方式上传需要自行解析UploadAuth。
|
示例
请求示例
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>eyJFbmRwb2ludCI6Imm****</UploadAuth>
</CreateUploadVideoResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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 |
创建视频信息失败,请稍后重试。 |
SDK示例
建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: