发起一个注册媒资的任务,赋予新媒资一个IMS的mediaId。接口根据InputURL,异步调用其他媒资信息服务,获取媒资的文件信息。同时用户可以设置一些基本信息的值,如标题、标签、描述等。接口同步返回mediaId,用户可以调用获取媒资内容信息GetMediaInfo的接口,获取具体的媒资信息。当前仅支持InputURL为OSS文件或VOD媒资。

注册媒资是一个异步任务,一般需要2-3s完成。当注册接口返回mediaId时,可能媒资还没有注册完成,此时调用GetMediaInfo无法获取到媒资的文件信息。

调试

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

请求参数

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

系统规定参数。取值:RegisterMediaInfo

InputURL String http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 vod://****20b48fb04483915d4f2cd8ac****

待注册的媒资在相应系统中的地址,一经注册不可更改,并与IMS的mediaId绑定。

  • OSS地址,支持两种格式。

http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4

oss://example-bucket/example.mp4 (此格式默认oss region与服务接入区域一致)

  • VOD媒资

vod://***20b48fb04483915d4f2cd8ac

MediaType String video

媒资媒体类型。取值范围:

  • "image" 图片
  • "video" 视频
  • "audio" 音频
  • "text" 文字
BusinessType String opening

媒资业务类型。取值范围:

  • "subtitles" 字幕
  • "watermark" 水印
  • "opening" 片头/开场
  • "ending" 片尾
  • "general" 通用
Title String defaultTitle

标题,若不提供,根据日期自动生成默认title。

  • 长度不超过128字节。
  • UTF8编码。
Description String defaultDescription

内容描述。

  • 长度不超过1024字节
  • UTF8编码。
Category String defaultCategory

分类。

  • 长度不超过64字节。
  • UTF8编码。
MediaTags String tag1,tag2

标签。

  • 最多不超过16个标签。
  • 多个用逗号分隔。
  • 单个标签不超过32字节。
  • UTF8编码。
CoverURL String http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png

封面地址。

  • 长度不超过128字节。
  • UTF8编码。
UserData String userData

用户数据。

  • 长度不超过1024字节。
  • UTF8编码。
Overwrite Boolean true

是否覆盖已注册媒资,默认false。

-true,如果inputUrl已注册,删除原有媒资并注册新媒资;

-false, 如果inputUrl已注册则不予注册新媒资,暂不支持重复的inputUrl。

ClientToken String ****0311a423d11a5f7dee713535****

客户端token,32位UUID,保证请求幂等性。

RegisterConfig String {"NeedSprite": "false"}

注册配置。

默认为媒资生成雪碧图,如不需要可以手动设置NeedSprite字段为false。

默认生成截图,如不需要可以手动设置NeedSnapshot字段为false。

返回数据

名称 类型 示例值 描述
RequestId String ******5A-CAAC-4850-A3AF-B74606******

请求ID。

MediaId String ******b48fb04483915d4f2cd8******

IMS媒资ID。

示例

请求示例

http(s)://[Endpoint]/?Action=RegisterMediaInfo
&InputURL=http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4  或  vod://****20b48fb04483915d4f2cd8ac****
&MediaType=video
&BusinessType=opening
&Title=defaultTitle
&Description=defaultDescription
&Category=defaultCategory
&MediaTags=tag1,tag2
&CoverURL=http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png
&UserData=userData
&Overwrite=true
&ClientToken=****0311a423d11a5f7dee713535****
&RegisterConfig={"NeedSprite": "false"}
&公共请求参数

正常返回示例

XML格式

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

<RegisterMediaInfoResponse>
    <RequestId>******5A-CAAC-4850-A3AF-B74606******</RequestId>
    <MediaId>******b48fb04483915d4f2cd8******</MediaId>
</RegisterMediaInfoResponse>

JSON格式

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

{
  "RequestId" : "******5A-CAAC-4850-A3AF-B74606******",
  "MediaId" : "******b48fb04483915d4f2cd8******"
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden User not authorized to operate on the specified resource. 无权限执行该操作。(一般是由于账号未获得相应权限,参考 账号授权策略。)

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