RegisterMediaInfo - 注册内容库资源

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

接口说明

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

调试

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

调试

授权信息

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

请求参数

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

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

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

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

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

  • VOD媒资

vod://***20b48fb04483915d4f2cd8ac****

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

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

  • "image" 图片

  • "video" 视频

  • "audio" 音频

  • "text" 文字

video
BusinessTypestring

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

  • "subtitles" 字幕

  • "watermark" 水印

  • "opening" 片头/开场

  • "ending" 片尾

  • "general" 通用

opening
Titlestring

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

  • 长度不超过128字节。

  • UTF8编码。

defaultTitle
Descriptionstring

内容描述。

  • 长度不超过1024字节

  • UTF8编码。

defaultDescription
MediaTagsstring

标签。

  • 最多不超过16个标签。

  • 多个用逗号分隔。

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

  • UTF8编码。

tag1,tag2
CoverURLstring

封面地址。

  • 长度不超过128字节。

  • UTF8编码。

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png
UserDatastring

用户数据。

  • 长度不超过1024字节。

  • UTF8编码。

userData
Overwriteboolean

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

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

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

true
ClientTokenstring

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

****0311a423d11a5f7dee713535****
RegisterConfigstring

注册配置。

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

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

{"NeedSprite": "false"}
CateIdLong

分类ID。

3048
WorkflowIdstring

工作流ID

******b4fb044839815d4f2cd8******

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

******5A-CAAC-4850-A3AF-B74606******
MediaIdstring

IMS媒资ID。

******b48fb04483915d4f2cd8******

示例

正常返回示例

JSON格式

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

错误码

Http code错误码错误信息描述
403ForbiddenUser not authorized to operate on the specified resource.无权限执行该操作。(一般是由于账号未获得相应权限,参考 账号授权策略。)
500RegisterMediaInfoFailedThe request processing has failed due to some unknown error.-

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

变更历史

变更时间变更内容概要操作
2021-04-07OpenAPI 错误码发生变更、 OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:RegisterConfig
阿里云首页 智能媒体生产 相关技术圈