RegisterMediaInfo - 注册内容库资源-否-资-注册-智能媒体服务-阿里云

发起一个注册媒资的任务，赋予新媒资一个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 或 vod://**20b48fb04483915d4f2cd8ac**
MediaType	string	是	媒资媒体类型。取值范围： "image" 图片 "video" 视频 "audio" 音频 "text" 文字	video
BusinessType	string	否	媒资业务类型。取值范围： "subtitles" 字幕 "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编码。	userData
Overwrite	boolean	否	是否覆盖已注册媒资，默认false。 -true，如果inputUrl已注册，删除原有媒资并注册新媒资； -false, 如果inputUrl已注册则不予注册新媒资，暂不支持重复的inputUrl。	true
ClientToken	string	否	客户端token，32位UUID，保证请求幂等性。	**0311a423d11a5f7dee713535**
RegisterConfig	string	否	注册配置。默认为媒资生成雪碧图，如不需要可以手动设置NeedSprite字段为false。默认生成截图，如不需要可以手动设置NeedSnapshot字段为false。	{"NeedSprite": "false"}
CateId	Long	否	分类ID。	3048
WorkflowId	string	否	工作流ID	****b4fb044839815d4f2cd8****
ReferenceId	string	否	自定义ID，仅支持小写字母、大写字母、数字、横线、下划线，长度6-64位。需保证用户维度唯一。	123-123

返回参数

名称	类型	描述	示例值
	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 code	错误码	错误信息	描述
403	Forbidden	User not authorized to operate on the specified resource.	无权限执行该操作。（一般是由于账号未获得相应权限，参考账号授权策略。）
500	RegisterMediaInfoFailed	The request processing has failed due to some unknown error.	-

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

变更历史

变更时间

变更内容概要

操作

2021-04-07

OpenAPI 错误码发生变更，OpenAPI 入参发生变更

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	删除错误码：403
	删除错误码：500
入参	OpenAPI 入参发生变更
	新增入参：RegisterConfig