发起一个注册媒资的任务,赋予新媒资一个IMS的mediaId。接口根据InputURL,异步调用其他媒资信息服务,获取媒资的文件信息。同时用户可以设置一些基本信息的值,如标题、标签、描述等。接口同步返回mediaId,用户可以调用获取媒资内容信息GetMediaInfo的接口,获取具体的媒资信息。当前仅支持InputURL为OSS文件或VOD媒资。
接口说明
注册媒资是一个异步任务,一般需要 2-3s 完成。当注册接口返回 mediaId 时,可能媒资还没有注册完成,此时调用 GetMediaInfo 无法获取到媒资的文件信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:RegisterMediaInfo | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InputURL | string | 是 | 待注册的媒资在相应系统中的地址,一经注册不可更改,并与 IMS 的 mediaId 绑定。
http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 oss://example-bucket/example.mp4 (此格式默认 oss region 与服务接入区域一致)
vod://***20b48fb04483915d4f2cd8ac**** | http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 或 vod://****20b48fb04483915d4f2cd8ac**** |
MediaType | string | 否 | 媒资媒体类型。取值范围:
此字段建议用户按需填写。当 InputURL 字段是 OSS URL 时,也支持按照文件后缀自动判断媒资类型(仅限图片、视频、音频文件后缀),对应关系见文件格式。 | video |
BusinessType | string | 否 | 媒资业务类型。取值范围:
| opening |
Title | string | 否 | 标题,若不提供,根据日期自动生成默认 title。
| defaultTitle |
Description | string | 否 | 内容描述。
| defaultDescription |
MediaTags | string | 否 | 标签。
| tag1,tag2 |
CoverURL | string | 否 | 封面地址。
| http://example-bucket.oss-cn-shanghai.aliyuncs.com/example.png |
UserData | string | 否 | 用户数据。支持自定义回调地址配置,配置说明可参考配置剪辑完成时的回调
| {"NotifyAddress":"http://xx.xx.xxx"} 或{"NotifyAddress":"https://xx.xx.xxx"} 或{"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。 | { "NeedSprite": "false" } |
CateId | long | 否 | 分类 ID。 | 3048 |
WorkflowId | string | 否 | 工作流 ID | ******b4fb044839815d4f2cd8****** |
ReferenceId | string | 否 | 自定义 ID,仅支持小写字母、大写字母、数字、横线、下划线,长度 6-64 位。需保证用户维度唯一。 | 123-123 |
SmartTagTemplateId | string | 否 | S00000101-300080 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "******5A-CAAC-4850-A3AF-B74606******",
"MediaId": "******b48fb04483915d4f2cd8******"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbidden | User not authorized to operate on the specified resource. | 无权限执行该操作。(一般是由于账号未获得相应权限,参考 账号授权策略。) |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-04-24 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-11 | OpenAPI 错误码发生变更 | 查看变更详情 |
2021-04-07 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |