调用CreateUploadImage获取图片上传地址和凭证。

使用说明

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

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:CreateUploadImage

Title String mytitle

图片标题。规则:

  • 长度不超过128个字符。
  • UTF-8编码。
ImageType String default

图片类型。取值:

  • default(默认)
  • cover(封面)
说明 控制台暂时仅支持default类型的图片管理。
ImageExt String png

图片文件扩展名。取值:

  • png(默认)
  • jpg
  • jpeg
  • gif
Tags String 测试

图片标签。规则:

  • 单个标签不超过32个字符。
  • 最多不超过16个标签。
  • 多个标签之间,请使用半角逗号(,)分隔。
  • UTF-8编码。
StorageLocation String outin-****..oss-cn-shanghai.aliyuncs.com

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

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

说明 当地址不为空时,会使用该指定的存储地址上传视频文件。
CateId Long 100036****

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

  • 登录点播控制台,选择配置管理 > 媒资管理配置 > 分类管理查看分类ID。
  • 通过创建分类接口创建分类时,分类ID为返回参数CateId的值。
  • 通过获取分类及子分类接口查询分类时,为请求后返回参数CateId的值。
UserData String {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}

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

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

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

Description String 图片上传测试

图片描述。

  • 长度不超过1024个字符。
  • UTF-8编码。
AppId String app-1000000

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

返回数据

名称 类型 示例值 描述
FileURL String http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png

文件OSS地址(不带鉴权)。添加水印时该地址可做添加水印接口的入参FileUrl。

RequestId String 25818875-5F78-AEF6-D7393642****

请求ID。

UploadAddress String eyJTZWN1cmuIjoiQ0FJU3p3TjF****

上传地址。

说明 接口返回的上传地址是Base64加密后的值。调用SDK或API完成媒资上传时需要对其进行Base64解码后再使用。解码的详细操作请参见上传地址和凭证的解析上传地址和凭证。
ImageURL String http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png

图片地址。

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

图片ID。

UploadAuth String eyJFbmmRCI6Im****

上传凭证。

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

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=CreateUploadImage
&Title=mytitle
&ImageType=default
&ImageExt=png
&Tags=测试
&StorageLocation=outin-****..oss-cn-shanghai.aliyuncs.com
&UserData={"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}
&Description=图片上传测试
&AppId=app-1000000
&公共请求参数

正常返回示例

XML格式

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

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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****"
}

错误码

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

SDK示例

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