点播服务下发上传地址和凭证以保障授权和安全,防止恶意上传,并在下发时自动创建媒体ID(MediaId),也叫视频ID(VideoId)用于管理。通过调用本接口可获取上传所需地址和凭证,并创建音视频信息。
接口说明
请确保在使用该接口前,已充分了解视频点播产品的收费方式和价格。媒资文件上传到视频点播中会产生存储费用,计费详情,请参见媒资存储计费。如果您已开通了存储传输加速,则上传媒资文件到视频点播时还将涉及上传加速费用,计费详情请参见存储传输加速计费。存储费用从文件上传成功开始计算,加速费用在开通后进行上传操作时进行计算,仅调用本接口不计费。
获取上传地址和凭证为点播服务的核心基础,是每个上传操作的必经过程。点播服务提供多种不同的上传方式,每种方式对获取上传地址和凭证的要求不同,详细内容请参见上传地址和凭证的使用说明。
本接口仅用于获取上传地址和凭证以及创建媒资基础信息,并非上传文件,通过接口上传的完整示例,请参见通过视频点播 API 上传媒资文件。
本接口既支持获取视频的上传地址和凭证,同时也支持获取音频的上传地址和凭证。具体操作,请参见上传地址和凭证。
如果视频上传凭证失效(默认有效期为 3000 秒),请调用 RefreshUploadVideo 接口重新获取上传凭证。
上传后,可通过配置回调,接收上传事件通知或调用 GetMezzanineInfo 接口根据返回的文件状态来判断是否上传成功。
本接口返回的 VideoId 参数,可以用于媒资生命周期管理或媒体处理。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vod:CreateUploadVideo |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| CoverURL |
string |
否 |
自定义视频封面的 URL 地址。 |
https://example.aliyundoc.com/image/D22F553TEST****.jpeg |
| Description |
string |
否 |
上传完成后,在点播中展示的音/视频描述。
|
UploadTest |
| FileName |
string |
是 |
待上传的音/视频源文件地址。
|
D:\video_01.mp4 |
| FileSize |
integer |
否 |
待上传的音/视频源文件的大小。单位:字节。 |
123 |
| Title |
string |
是 |
上传完成后,在点播中展示的音/视频标题。
|
UploadTest |
| CateId |
integer |
否 |
分类 ID。可通过以下方式获取:
|
100036**** |
| Tags |
string |
否 |
音/视频标签。
|
tag1,tag2 |
| UserData |
string |
否 |
自定义设置。为 JSON 字符串,支持消息回调、上传加速等设置。更多信息,请参见 UserData 。 |
{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"*****","test":"www"}} |
| TemplateGroupId |
string |
否 |
转码模板组 ID。可通过以下方式获取: |
405477f9e214d19ea2c7c854**** |
| WorkflowId |
string |
否 |
工作流 ID。可登录点播控制台,选择配置管理 > 媒体处理配置 > 工作流管理查看工作流 ID。 说明
如果同时传递了 WorkflowId 和 TemplateGroupId,以 WorkflowId 为准。使用说明,请参见工作流。 |
613efff3887ec34af685714cc461**** |
| StorageLocation |
string |
否 |
存储地址。可通过以下方式获取: 登录点播控制台,选择配置管理 > 媒资管理配置 > 存储管理查看存储地址。 说明
若不传此参数,则音视频文件上传至默认的存储地址上(无默认存储地址时上传至存储列表第一个存储地址);若传入此参数,则音视频文件上传至该指定的存储地址上。 |
out-****.oss-cn-shanghai.aliyuncs.com |
| AppId |
string |
否 |
应用 ID。默认取值:app-1000000。更多信息,请参见多应用。 |
app-1000000 |
| ReferenceId |
string |
否 |
123-123 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
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****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。