调用RegisterMedia进行媒资注册。
支持对已接入点播服务的OSS bucket中已存在的音视频媒体文件的注册,注册媒资成功后,可根据媒体ID发起转码、截图和AI处理(如审核)等。
说明
- 一次最多可注册10个OSS媒体文件,且一次提交的文件对应的存储地址需要一致。
- 与视频上传不同的是,注册媒资后,如未指定转码模板组ID,则不会自动触发转码;如指定,则会按照指定的模板组进行转码。
- 重复注册的媒体文件,只返回与其关联的惟一媒体ID,不做其他处理。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | RegisterMedia |
系统规定参数。取值:RegisterMedia。 |
RegisterMetadatas | String | 是 | {"Title":"ceshi"} |
注册媒资元数据。为JSON字符串,一次最多支持设置10个媒资元数据。参数结构详情,请参见MediaMetadata。 |
TemplateGroupId | String | 否 | ca3a8f6e49c8*****7b65806709586 |
转码模板组ID。 您可以通过AddTranscodeTemplateGroup接口获取。 说明 当不为空时,会使用指定的模板组进行转码。登录点播控制台,在转码设置里查看模版组ID。
|
UserData | String | 否 | {"Extend":{"localId":"****","test":"www"}} |
自定义设置。为JSON字符串,支持消息回调等设置。参数详情,请参见UserData。 |
WorkflowId | String | 否 | 637adc2b7ba*****51a83d841606f8 |
工作流ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
FailedFileURLs | List | ["http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_03.mp4"] |
注册失败的文件地址列表。 |
RegisteredMediaList | Array of RegisteredMedia |
本次注册成功的Media列表,包括新增注册和已注册成功过的文件。 |
|
FileURL | String | http://****.oss-cn-shanghai.aliyuncs.com/vod_sample_01.mp4 |
OSS文件地址。 |
MediaId | String | d97af32828084*****d1896683b1aa38 |
点播媒体ID。当注册的媒体文件为音视频时,对应点播的VideoId。 |
NewRegister | Boolean | false |
新注册或重复注册。
|
RequestId | String | 14F43C5C-8033-4*****48B-AD04F64E5098 |
请求ID。 |
示例
请求示例
https://vod.aliyuncs.com/?Action=RegisterMedia
&RegisterMetadatas={"Title":"ceshi"}
&<公共请求参数>
正常返回示例
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
格式
{
"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"
]
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交