文档

RegisterMediaInfo - 注册内容库资源

更新时间:

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:RegisterMediaInfoWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
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" 文字

此字段建议用户按需填写。当 InputURL 字段是 OSS URL 时,也支持按照文件后缀自动判断媒资类型(仅限图片、视频、音频文件后缀),对应关系见文件格式

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 编码。

  • Json 格式

{"NotifyAddress":"http://xx.xx.xxx"} 或{"NotifyAddress":"https://xx.xx.xxx"} 或{"NotifyAddress":"ice-callback-demo"}
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******
ReferenceIdstring

自定义 ID,仅支持小写字母、大写字母、数字、横线、下划线,长度 6-64 位。需保证用户维度唯一。

123-123

返回参数

名称类型描述示例值
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 status code错误码错误信息描述
403ForbiddenUser not authorized to operate on the specified resource.无权限执行该操作。(一般是由于账号未获得相应权限,参考 账号授权策略。)

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

变更历史

变更时间变更内容概要操作
2023-04-11OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:500
2021-04-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:RegisterConfig
  • 本页导读 (1)
文档反馈