调用SubmitCopyrightJob接口为视频添加版权水印-智能媒体服务-阿里云-智能媒体服务(IMS)-阿里云帮助中心

调用SubmitCopyrightJob提交视频版权水印任务。

接口说明

提交视频版权水印作业默认仅支持 3 分钟及以上视频，视频时间过短会导致接口调用失败或无输出。如果需要对 3 分钟以内的短视频添加版权水印，可以通过 Params 参数指定，详见参数描述。
提交视频版权水印作业每次接口的调用，都是对独立视频进行添加水印，不支持多个视频同时提交。
目前数字水印相关接口只支持华东 2（上海）、华北 2（北京）地域使用。
该接口为异步接口，提交任务后返回任务 ID（此时任务尚未完成，任务将进入后台排队异步执行），最终结果将通过回调通知，也可通过查询视频版权水印作业列表主动查询任务状态。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:SubmitCopyrightJob

none

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Input	object	是	待添加水印的视频文件。说明 OSS 文件/媒资的地域需要与当前 IMS 所在地域保持一致。
Type	string	是	输入文件类型，取值： OSS：OSS 文件地址 Media：媒资 ID	OSS
Media	string	是	输入文件信息，支持 OSS 地址和媒资 ID 两种。 OSS 地址规则为： 1、oss://bucket/object 2、http(s)://bucket.oss-[regionId].aliyuncs.com/object 其中 bucket 为和当前项目处于同一区域的 oss bucket 名称，object 为文件路径。	oss://bucket/object
Output	object	是	输出文件地址。说明 OSS 的地域需要与当前 IMS 所在地域保持一致。
Type	string	是	输出文件类型，取值： OSS：OSS 文件地址。	OSS
Media	string	是	输出文件信息，支持 OSS 地址。 OSS 地址规则为： 1、oss://bucket/object 2、http(s)://bucket.oss-[regionId].aliyuncs.com/object 其中 bucket 为和当前项目处于同一区域的 oss bucket 名称，object 为文件路径。	oss://test-bucket/output.mp4
Message	string	是	待添加的水印信息。	版权水印测试
StartTime	integer	否	水印起始时间，单位为秒，不填写默认为 0。	0
TotalTime	integer	否	水印结束时间，单位为秒，不填写默认为视频时长。	10
Level	integer	否	水印级别，取值 0/1/2，表示嵌入通道，0u，1uv，2yuv。	0
Description	string	否	水印信息描述。	任务描述
UserData	string	否	用户自定义数据，最大长度 1024 字节。	123
Params	string	否	水印任务参数，JSONString。目前支持设置参数如下： algoType：算法类型，默认值为 v1。 v1：长视频版权水印，仅支持 3min 以上的。 v2：短视频版权水印。	{"algoType":"v2"}

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Data	object	返回数据
JobId	string	任务 id	bfb786c63****f4d80648792021eff90
Message	string	返回信息	ok
RequestId	string	Id of the request	FA258E67-09B8-4EAA-8F33-BA567834A2C3
StatusCode	integer	状态码	200

示例

正常返回示例

JSON格式

{
  "Data": {
    "JobId": "bfb786c63****f4d80648792021eff90"
  },
  "Message": "ok",
  "RequestId": "FA258E67-09B8-4EAA-8F33-BA567834A2C3\n",
  "StatusCode": 200
}

错误码

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

变更历史

更多信息，参考变更详情。