调用RegisterMedia进行媒资注册。

使用说明

针对已接入点播服务的OSS bucket,已存储在OSS bucket上的音视频媒体文件,需要通过注册媒资接口生成点播需要的关联数据后,才能在点播服务中对这些媒体文件通过媒体ID发起转码、截图和AI处理等。更多信息,请参见转码截图审核

说明
  • 一次最多可注册10个OSS媒体文件,且一次提交的媒体文件对应的存储地址需要一致。
  • 在点播中上传的媒体文件,如未指定转码模板组ID,则会按照默认模板组进行转码处理;与之不同的是,注册媒资后,如未指定转码模板组ID,则不会自动触发转码;如指定了转码模板组ID,则会按照指定的模板组进行转码处理。
  • 重复注册的媒体文件,只返回与其关联的唯一媒体ID,不做其他处理。

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

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

系统规定参数。取值:RegisterMedia

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

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

TemplateGroupId String ca3a8f6e49c87b65806709586****

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

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

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

WorkflowId String 637adc2b7ba51a83d841606f8****

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

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

RegisterMetadata

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

名称

类型

是否必选

描述

FileURL

String

源文件地址。可通过获取源文件信息接口获取。

长度不超过1024个字节,文件名需要保证全局唯一。添加相同文件名称时,则关联唯一媒体ID。

Title

String

标题。长度不超过128个字节。UTF8编码。

Description

String

描述。长度不超过1024个字节。UTF8编码。

Tags

String

标签。单个标签不超过32个字节,最多不超过16个标签,多个标签之间用半角逗号(,)分隔。UTF8编码。

CoverURL

String

封面URL。长度不超过1024个字节。

CateId

Long

分类ID。可通过以下方式获取:

登录点播控制台,选择配置管理 > 媒资管理配置 > 分类管理查看分类ID。

通过创建分类接口创建分类时,分类ID为返回参数CateId的值。

通过获取分类及子分类接口查询分类时,为请求后返回参数CateId的值。

返回数据

名称 类型 示例值 描述
RequestId String 14F43C5C-8033-448B-AD04F64E5098****

请求ID。

FailedFileURLs Array of String ["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"]

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

RegisteredMediaList Array of RegisteredMedia

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

NewRegister Boolean false

新注册或重复注册。

  • true:表示新注册。
  • false:表示重复注册。
FileURL String http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4

OSS文件地址。

MediaId String d97af32828084d1896683b1aa38****

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

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=RegisterMedia
&RegisterMetadatas=[{"FileURL":"https://****.oss-cn-shanghai.aliyuncs.com/video/test/video123.m3u8","Title":"VideoName"}]
&UserData={"Extend":{"localId":"****","test":"www"}}
&WorkflowId=637adc2b7ba51a83d841606f8****
&<公共请求参数>

正常返回示例

XML格式

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

<RegisterMediaResponse>
    <RequestId>14F43C5C-8033-43E7-B48B-AD04F64E5098</RequestId>
    <RegisteredMediaList>
        <MediaId>d97af328280842229aed1896683b1aa38</MediaId>
        <FileURL>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4</FileURL>
        <NewRegister>true</NewRegister>
    </RegisteredMediaList>
    <RegisteredMediaList>
        <MediaId>d97af328280842229aed1896683b1aa38</MediaId>
        <FileURL>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_02.mp4</FileURL>
        <NewRegister>false</NewRegister>
    </RegisteredMediaList>
    <FailedFileURLs>http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4</FailedFileURLs>
</RegisterMediaResponse>

JSON格式

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

{
  "RequestId" : "14F43C5C-8033-43E7-B48B-AD04F64E5098",
  "RegisteredMediaList" : [ {
    "MediaId" : "d97af328280842229aed1896683b1aa38",
    "FileURL" : "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4",
    "NewRegister" : true
  }, {
    "MediaId" : "d97af328280842229aed1896683b1aa38",
    "FileURL" : "http://*****.oss-cn-shanghai.aliyuncs.com/vod_sample_02.mp4",
    "NewRegister" : false
  } ],
  "FailedFileURLs" : [ "http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4" ]
}

错误码

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