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

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

接口说明

使用说明

  • 获取上传地址和凭证为点播服务的核心基础，是每个上传操作的必经过程。点播服务提供了服务端上传SDK、客户端上传SDK、离线拉取上传、基于OSS服务端API上传、基于OSS原生SDK上传等不同的上传方式，每种方式对获取上传地址和凭证的要求不同，详细内容请参见上传地址和凭证的使用说明。
  • 上传图片不支持刷新上传地址和凭证。如果图片上传凭证失效（ 默认有效期3000秒），请重新调用此接口获取上传地址和凭证。
  • 图片水印通过获取辅助媒资上传地址和凭证接口上传。
  • 可通过配置回调，接收图片上传完成的事件通知来判断是否上传成功。

QPS限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Titlestring否

图片标题。规则：

  • 长度不超过128个字符。
  • UTF-8编码。
mytitle
ImageTypestring是

图片类型。取值：

  • default（默认）
  • cover（封面）
说明控制台暂时仅支持default类型的图片管理。
default
ImageExtstring否

图片文件扩展名。取值：

  • png（默认）
  • jpg
  • jpeg
  • gif
png
Tagsstring否

图片标签。规则：

  • 单个标签不超过32个字符。
  • 最多不超过16个标签。
  • 多个标签之间，请使用半角逗号（,）分隔。
  • UTF-8编码。
测试
StorageLocationstring否

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

说明当地址不为空时，会使用该指定的存储地址上传视频文件。
outin-****..oss-cn-shanghai.aliyuncs.com
CateIdLong否

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

  • 登录点播控制台，选择配置管理 > 媒资管理配置 > 分类管理查看分类ID。
  • 通过创建分类接口创建分类时，分类ID为返回参数CateId的值。
  • 通过获取分类及子分类接口查询分类时，为请求后返回参数CateId的值。
100036****
UserDatastring否

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

说明
  • 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。控制台配置HTTP回调的操作，请参考回调设置。
  • 上传加速功能在使用前请您提交工单开通，更多信息，请参见上传相关说明。
    • 说明
  • 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用，否则回调设置不生效。控制台配置HTTP回调的操作，请参考回调设置。
  • 上传加速功能在使用前请您提交工单开通，更多信息，请参见上传相关说明。
    		• {"MessageCallback":{"CallbackURL":"http://example.aliyundoc.com"},"Extend":{"localId":"xxx","test":"www"}}
    Descriptionstring否

    图片描述。

    • 长度不超过1024个字符。
    • UTF-8编码。
    		图片上传测试
    AppIdstring否

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

    		app-1000000

    返回参数

    名称类型描述示例值
    object

    返回结果。

    FileURLstring

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

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

    请求ID。

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

    上传地址。

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

    图片地址。

    说明如果返回的ImageURL在浏览器无法访问（403），是因为您开启了点播域名的鉴权功能。可关闭URL鉴权或自助生成鉴权签名。
    		http://example.aliyundoc.com/cover/2017-34DB-4F4C-9373-003AA060****.png
    ImageIdstring

    图片ID。

    		93ab850b4f6f46e91d24d81d4****
    UploadAuthstring

    上传凭证。

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

    示例

    请求示例

    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
&公共请求参数

    正常返回示例

    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****"
}

    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>

    错误码

    访问错误中心查看更多错误码。
    阿里云首页 视频点播 相关技术圈