文档

CreateUploadMedia - 获取媒资上传地址和凭证

更新时间:

获取媒资上传地址和凭证,并创建媒资信息。

接口说明

  • 此接口既支持获取音视频的上传地址和凭证,同时也支持获取图片和辅助媒资的上传地址和凭证。
  • 获取上传地址和凭证为智能媒体服务的核心基础,是每个上传操作的必经过程。
  • 如果视频上传凭证失效(默认有效期为 3000 秒),请调用刷新视频上传凭证接口重新获取上传凭证。
  • 上传后,可通过配置回调,接收上传事件通知或调用 GetMediaInfo 接口根据返回的媒资状态来判断是否上传成功。
  • 本接口返回的 MediaId 参数,可以用于媒资生命周期管理或媒体处理。
  • 本接口仅支持上传至 VOD 点播存储,不支持上传至用户自有 OSS 存储。使用自有 OSS 存储的用户,可以先通过OSS SDK上传文件至 OSS,再调用 RegisterMediaInfo 接口将 OSS 文件注册至媒资库。
  • 本接口目前仅支持华东 2(上海)、华北 2(北京)、华南 1(深圳)地域。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。默认取值:app-1000000。

app-1000000
EntityIdstring

实体 ID。可调用 CreateEntity 接口创建实体,自定义动态元数据结构。

9e177cac2fb44f8b8c67b199fcc7bffd
FileInfostring

文件信息,JSON 类型,包含参数字段:

  • Type(必填):文件类型,取值 video、image、audio、text、other。
  • Name(必填):文件名,不带扩展名。
  • Size(选填):文件大小。
  • Ext(必填):文件扩展名。
{\"Type\":\"video\",\"Name\":\"test\",\"Size\":108078336,\"Ext\":\"mp4\"}
UserDatastring

自定义设置。为 JSON 字符串,支持消息回调等设置。

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

目标存储地址。

StorageType 取值:仅支持 oss。

StorageLocation 仅支持 VOD 点播存储,不支持用户自有 OSS 存储。

{\"StorageType\":\"oss\",\"StorageLocation\":\"outin-***.oss-cn-shanghai.aliyuncs.com\"}
MediaMetaDatastring

上传媒资的元数据,JSON 格式。

Title 标题(必填):

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

Description 描述(选填):

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

CateId 分类 ID(选填)。

Tags 标签(选填)。

BusinessType 业务类型(必填),取值:

  • Type = video ,取值: opening: 片头/开场;ending: 片尾
  • Type = image ,取值: default:默认; cover:封面
  • Type = text ,取值: subtitles:字幕; font:字体;
  • Type=material ,取值: watermark:水印;
  • general 通用; CoverURL 封面(选填)。

DynamicMetaData 动态元数据,类型为字符串。

{\"Title\": \"UploadTest\", \"Description\": \"UploadImageTest\", \"Tags\": \"tag1,tag2\",\"BusinessType\":\"cover\"}
PostProcessConfigstring

Type = video || audio 有上传后处理动作。

ProcessType 取值:Workflow。

{\"ProcessType\":\"Workflow\",\"ProcessID\":\"74ba870f1a4873a3ba238e0bf6fa9***\"}

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

4E84BE44-58A7-****-****-FBEBEA16EF94
MediaIdstring

媒资 ID。

****20b48fb04483915d4f2cd8ac****
MediaURLstring

媒资地址。

说明 如果配置了 CDN 域名则返回 CDN 地址,否则为 OSS 地址。说明如果返回的 MediaURL 在浏览器无法访问(403),是因为您开启了点播域名的鉴权功能。可关闭 URL 鉴权或自助生成鉴权签名。
https://xxq-live-playback.oss-cn-shanghai.aliyuncs.com/capture/5d96d2b4-111b-4e5d-a0e5-20f44405bb55.mp4
FileURLstring

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

http://outin-***.oss-cn-north-2-gov-1.aliyuncs.com/sv/40360f05-181f63c3110-0004-cd8e-27f-de3c9.mp4
UploadAddressstring

上传地址。

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

上传凭证。

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

示例

正常返回示例

JSON格式

{
  "RequestId": "4E84BE44-58A7-****-****-FBEBEA16EF94",
  "MediaId": "****20b48fb04483915d4f2cd8ac****",
  "MediaURL": "https://xxq-live-playback.oss-cn-shanghai.aliyuncs.com/capture/5d96d2b4-111b-4e5d-a0e5-20f44405bb55.mp4",
  "FileURL": "http://outin-***.oss-cn-north-2-gov-1.aliyuncs.com/sv/40360f05-181f63c3110-0004-cd8e-27f-de3c9.mp4",
  "UploadAddress": "eyJTZWN1cml0a2VuIjoiQ0FJU3p3TjF****",
  "UploadAuth": "eyJFbmRwb2ludCI6Imm****"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈