CreateUploadImage - 获取图片上传地址和凭证

更新时间:
复制 MD 格式

点播服务下发上传地址和凭证以保障授权和安全,防止恶意上传,并在下发时自动创建图片ID(ImageId)用于管理。通过调用本接口可获取上传所需地址和凭证,并创建图片信息。

接口说明

  • 请确保在使用该接口前,已充分了解视频点播产品的收费方式和价格。媒资文件上传到视频点播中会产生存储费用,计费详情,请参见媒资存储计费。如果您已开通了存储传输加速,则上传媒资文件到视频点播时还将涉及上传加速费用,计费详情请参见存储传输加速计费

  • 本接口仅用于获取上传地址和凭证以及创建媒资基础信息,并非上传文件,通过接口上传的完整示例,请参见通过视频点播 API 上传媒资文件

  • 上传图片不支持刷新上传地址和凭证。如果图片上传凭证失效( 默认有效期 3000 秒),请重新调用此接口获取上传地址和凭证。

  • 可通过配置回调,接收图片上传完成的事件通知来判断是否上传成功。

  • 获取上传地址和凭证为点播服务的核心基础,是每个上传操作的必经过程。点播服务提供多种不同的上传方式,每种方式对获取上传地址和凭证的要求不同,详细内容请参见上传地址和凭证的使用说明。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vod:CreateUploadImage

create

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Title

string

图片标题。规则:

  • 长度不超过 128 个字符。

  • UTF-8 编码。

mytitle

ImageType

string

图片类型。取值:

  • default(默认):普通图片

  • cover:视频封面图

说明

点播控制台目前仅支持对 default 类型的图片进行查看和管理。

default

ImageExt

string

待上传的图片源文件的扩展名。取值:

  • png(默认)

  • jpg

  • jpeg

  • gif

  • heic

  • webp

png

OriginalFileName

string

待上传的图片源文件地址。

说明

可不带扩展名;若此处带了扩展名,且此处的扩展名与ImageExt中设置的扩展名不一致,以ImageExt为准。

D:\picture_01

Tags

string

图片标签。规则:

  • 单个标签不超过 32 个字符。

  • 最多不超过 16 个标签。

  • 多个标签之间,请使用半角逗号(,)分隔。

  • UTF-8 编码。

Test

StorageLocation

string

存储地址。可通过以下方式获取: 登录点播控制台,选择配置管理 > 媒资管理配置 > 存储管理查看存储地址。

说明

若不传此参数,则图片上传到默认的存储地址上;若传入此参数,则图片上传到该指定的存储地址上。

outin-****..oss-cn-shanghai.aliyuncs.com

CateId

integer

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

  • 登录点播控制台,选择配置管理 > 媒资管理配置 > 分类管理查看分类 ID。

  • 通过 AddCategory 接口创建分类时,分类 ID 为返回参数 CateId 的值。

  • 通过 GetCategories 接口查询分类时,为请求后返回参数 CateId 的值。

100036****

UserData

string

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

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

  • 如需使用上传加速功能,请提交工单申请开通,更多信息,请参见上传相关说明。关于如何提交工单,请参见联系我们

{"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}

Description

string

图片描述。

  • 长度不超过 1024 个字符。

  • UTF-8 编码。

Image upload test

AppId

string

应用 ID。默认取值:app-1000000。若已开通多应用体系,传入应用 ID,可将图片上传到指定应用下。更多信息,请参见多应用

app-1000000

返回参数

名称

类型

描述

示例值

object

返回结果。

FileURL

string

图片文件的 OSS 地址(不带鉴权)。

添加图片水印模板时,该地址可作为 AddWatermark 接口的请求参数FileUrl

http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png

RequestId

string

请求 ID。

25818875-5F78-AEF6-D7393642****

UploadAddress

string

上传地址。

说明

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

eyJTZWN1cmuIjoiQ0FJU3p3TjF****

ImageURL

string

图片的访问地址。

说明

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

http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png

ImageId

string

图片 ID。可作为 GetImageInfoGetImageInfosUpdateImageInfosDeleteImage 等接口的请求参数。

93ab850b4f6f46e91d24d81d4****

UploadAuth

string

上传凭证。

说明

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

eyJFbmmRCI6Im****

示例

正常返回示例

JSON格式

{
  "FileURL": "http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png",
  "RequestId": "25818875-5F78-AEF6-D7393642****",
  "UploadAddress": "eyJTZWN1cmuIjoiQ0FJU3p3TjF****",
  "ImageURL": "http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png",
  "ImageId": "93ab850b4f6f46e91d24d81d4****",
  "UploadAuth": "eyJFbmmRCI6Im****"
}

错误码

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

变更历史

更多信息,参考变更详情