文档

RegisterMedia - 注册媒资信息

进行媒资注册,接入点播服务的OSS自有Bucket上的存量媒资文件,需要进行媒资注册生成点播需要的关联数据后,才能正常使用点播提供的转码、截图等功能。

接口说明

  • 针对已接入点播服务的 OSS bucket,已存储在 OSS bucket 上的音视频媒体文件,需要通过注册媒资接口生成点播需要的关联数据后,才能在点播服务中对这些媒体文件通过媒体 ID 发起转码、截图和 AI 处理等。
  • 一次最多可注册 10 个 OSS 媒体文件,且一次提交的媒体文件对应的存储地址需要一致。
  • 在点播中上传的媒体文件,如未指定转码模板组 ID,则会按照默认模板组进行转码处理;与之不同的是,注册媒资后,如未指定转码模板组 ID,则不会自动触发转码;如指定了转码模板组 ID,则会按照指定的模板组进行转码处理。
  • 重复注册的媒体文件,只返回与其关联的唯一媒体 ID,不做其他处理。
  • 请确保您要注册的媒资文件含有合法的后缀,否则会注册失败。

调试

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

授权信息

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

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

请求参数

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

注册媒资元数据。为 JSON 字符串,一次最多支持设置 10 个媒资元数据。参数结构的更多信息,请参见下表 RegisterMetadata

[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]
TemplateGroupIdstring

转码模板组 ID。可通过以下方式获取:

  • 登录点播控制台,选择配置管理 > 媒体处理配置 > 转码模板组查看转码模版组 ID。
  • 通过创建转码模板组接口创建转码模板组时,转码模板组 ID 为返回参数 TranscodeTemplateGroupId 的值。
  • 通过查询转码配置列表接口查询转码模板组时,为请求后返回参数 TranscodeTemplateGroupId 的值。
说明
  • 如果不需要转码无转码,请指定 TemplateGroupId 为 VOD_NO_TRANSCODE(不转码模板组),否则视频会出现异常。如果需要转码,则指定转码模板组 ID。
  • 如果同时传递了 WorkflowId 和 TemplateGroupId,以 WorkflowId 为准。使用说明,请参见工作流
  • ca3a8f6e49c87b65806709586****
    UserDatastring

    自定义设置。为 JSON 字符串,支持消息回调等设置。参数详情,请参见 UserData

    说明 本接口不支持回调,即便此参数中设置了消息回调,在媒资注册完成后也不会产生回调消息。当后续对注册完成的媒资发起转码、截图等媒体处理时,若在发起转码、截图时单独设置了 UserData 中的消息回调,则优先使用那个回调地址;未设置,则使用此处注册媒资时 UserData 中设置的回调地址。
    {"Extend":{"localId":"****","test":"www"}}
    WorkflowIdstring

    工作流 ID。可登录点播控制台,选择配置管理 > 媒体处理配置 > 工作流管理查看工作流 ID。

    说明 如果同时传递了 WorkflowId 和 TemplateGroupId,以 WorkflowId 为准。使用说明,请参见工作流
    637adc2b7ba51a83d841606f8****

    RegisterMetadata

    指定要注册的媒资元数据。

    名称类型是否必选描述
    FileURLString源文件地址。可通过获取源文件信息接口获取。
    长度不超过 1024 个字节,文件名需要保证全局唯一。添加相同文件名称时,则关联唯一媒体 ID。
    TitleString标题。长度不超过 128 个字节。UTF8 编码。
    DescriptionString描述。长度不超过 1024 个字节。UTF8 编码。
    TagsString标签。单个标签不超过 32 个字节,最多不超过 16 个标签,多个标签之间用半角逗号(,)分隔。UTF8 编码。
    CoverURLString封面 URL。长度不超过 1024 个字节。
    CateIdLong分类 ID。可通过以下方式获取:
    登录点播控制台,选择配置管理 > 媒资管理配置 > 分类管理查看分类 ID。
    通过创建分类接口创建分类时,分类 ID 为返回参数 CateId 的值。
    通过获取分类及子分类接口查询分类时,为请求后返回参数 CateId 的值。

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    14F43C5C-8033-448B-AD04F64E5098****
    FailedFileURLsarray

    注册失败的文件地址列表。

    string

    注册失败的文件地址列表。

    ["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]
    RegisteredMediaListobject []

    本次注册成功的 Media 列表,包括新增注册和已注册成功过的文件。

    NewRegisterboolean

    新注册或重复注册。

    • true:表示新注册。
    • false:表示重复注册。
    false
    FileURLstring

    OSS 文件地址。

    http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4
    MediaIdstring

    点播媒体 ID。当注册的媒体文件为音视频时,对应点播的 VideoId。

    d97af32828084d1896683b1aa38****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "14F43C5C-8033-448B-AD04F64E5098****",
      "FailedFileURLs": [
        "[\"http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4\"]"
      ],
      "RegisteredMediaList": [
        {
          "NewRegister": false,
          "FileURL": "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4",
          "MediaId": "d97af32828084d1896683b1aa38****"
        }
      ]
    }

    错误码

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