全部产品
Search

搜索本产品

    智能媒体服务：RegisterMediaInfo - 注册内容库资源

    文档中心

    智能媒体服务：RegisterMediaInfo - 注册内容库资源

    更新时间：Jul 28, 2026

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

    接口说明

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

    调试

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

    调试

    授权信息

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

    请求参数

    名称

    类型

    必填

    描述

    示例值
    InputURL

    string

    是

    待注册的媒资在相应系统中的地址，一经注册不可更改，并与 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  or  vod://****20b48fb04483915d4f2cd8ac****
    MediaType

    string

    否

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

    • "image" 图片

    • "video" 视频

    • "audio" 音频

    • "text" 文字

    当取值为"text"时，businessType 需对应"subtitles"或"font"。

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

    video
    BusinessType

    string

    否

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

    • "subtitles" 字幕

    • "font" 字体

    • "watermark" 水印

    • "opening" 片头/开场

    • "ending" 片尾

    • "general" 通用

    opening
    Title

    string

    否

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

    • 长度不超过 128 字节。

    • UTF8 编码。

    defaultTitle
    Description

    string

    否

    内容描述。

    • 长度不超过 1024 字节

    • UTF8 编码。

    defaultDescription
    MediaTags

    string

    否

    标签。

    • 最多不超过 16 个标签。

    • 多个用逗号分隔。

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

    • UTF8 编码。

    tag1,tag2
    CoverURL

    string

    否

    封面地址。

    • 长度不超过 128 字节。

    • UTF8 编码。

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

    string

    否

    用户数据。支持自定义回调地址配置，配置说明可参考配置剪辑完成时的回调

    • 长度不超过 1024 字节。

    • UTF8 编码。

    • Json 格式

    {"NotifyAddress":"http://xx.xx.xxx"} or{"NotifyAddress":"https://xx.xx.xxx"} or{"NotifyAddress":"ice-callback-demo"}
    Overwrite

    boolean

    否

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

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

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

    true
    ClientToken

    string

    否

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

    ****0311a423d11a5f7dee713535****
    RegisterConfig

    string

    否

    注册配置。

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

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

    如需指定封面图时间，需配置 CoverConfig，包含字段：

    • StartTime: 封面图位于素材的第几秒，支持四位小数。

    媒资注册后，如需导入自定义搜索库，需配置 SearchLibName。如何创建并使用自定义搜索库，详见自建搜索库的使用流程。

    { "NeedSprite": "false", "CoverConfig": { "StartTime": 1.0 }, "SearchLibName": "test" }
    CateId

    integer

    否

    分类 ID。

    3048
    WorkflowId

    string

    否

    工作流 ID

    ******b4fb044839815d4f2cd8******
    ReferenceId

    string

    否

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

    123-123
    SmartTagTemplateId

    string

    否

    智能标签模板。取值：

    • S00000101-300080：包含 NLP 内容理解功能的系统模板

    • S00000103-000001：包含 NLP 内容理解功能和所有标签能力

    • S00000103-000002：包含所有标签能力，不包含 NLP 内容理解功能

    标签能力详见：

    配置该字段后，媒资注册完成会自动发起智能标签分析任务，相关计费项请参考 智能标签标准版计费。

    S00000101-300080

    返回参数

    名称

    类型

    描述

    示例值

    object

    Schema of Response

    RequestId

    string

    请求 ID。

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

    string

    IMS 媒资 ID。

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

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    403 Forbidden User not authorized to operate on the specified resource.

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

    变更历史

    更多信息，参考变更详情。