SubmitCopyrightJob-Intelligent Media Services(IMS)-阿里云帮助中心

Submits a video copyright watermark job.

Operation description

By default, committing a video copyright watermark job supports only videos that are 3 minutes or longer. If the video is too short, it may result in a failed API invocation or no output. To add a copyright watermark to a short video of less than 3 minutes, specify the parameter in Params. For more information, see the parameter description.
Each time you invoke the API to commit a video copyright watermark job, a watermark is added to a single video. Committing multiple videos at the same time is not supported.
Currently, API operations related to digital watermarking are supported only in the China (Shanghai) and China (Beijing) regions.
This is an asynchronous API operation. After you commit the node, a node ID is returned. The node is not completed at this time and enters the background queue to execute asynchronously. The final result is notified by a callback. You can also actively query the node status by calling the List video copyright watermark jobs operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:SubmitCopyrightJob

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Input	object	Yes	The video file to which the watermark is to be added. Note The region of the OSS file or media asset must be the same as the region of the current IMS.
Type	string	Yes	The type of the input file. Valid values: OSS: the URL of the OSS file. Media: the ID of the media asset.	OSS
Media	string	Yes	The information about the input file. Both OSS URLs and media asset IDs are supported. The OSS URL rules are as follows: oss://bucket/object http(s)://bucket.oss-[regionId].aliyuncs.com/object In the URLs, bucket is the name of the OSS bucket that is in the same region as the current project, and object is the file path.	oss://bucket/object
Output	object	Yes	The URL of the output file. Note The region of OSS must be the same as the region of the current IMS.
Type	string	Yes	The type of the output file. Valid values: OSS: the URL of the OSS file.	OSS
Media	string	Yes	The information about the output file. Only OSS URLs are supported. The OSS URL rules are as follows: oss://bucket/object http(s)://bucket.oss-[regionId].aliyuncs.com/object In the URLs, bucket is the name of the OSS bucket that is in the same region as the current project, and object is the file path.	oss://test-bucket/output.mp4
Message	string	Yes	The watermark information to be added.	Copyright watermark test
StartTime	integer	No	The start time of the watermark, in seconds. If you do not specify this parameter, the default value is 0.	0
TotalTime	integer	No	The end time of the watermark, in seconds. If you do not specify this parameter, the default value is the duration of the video.	10
Level	integer	No	The watermark level, which indicates the embedding channel. Valid values: 0 (0u), 1 (1uv), and 2 (2yuv).	0
Description	string	No	The description of the watermark information.	Task description
UserData	string	No	The user-defined data, with a maximum length of 1,024 bytes.	123
Params	string	No	The parameters of the watermark job, in the JSON string format. The following parameters are supported: algoType: the algorithm type. Default value: v1. v1: long video copyright watermark, which supports only videos longer than 3 minutes. v2: short video copyright watermark.	{"algoType":"v2"}

Response elements

Element	Type	Description	Example
	object	Schema of Response
Data	object	The response data.
JobId	string	The job ID.	bfb786c63****f4d80648792021eff90
Message	string	The response message.	ok
RequestId	string	Id of the request	FA258E67-09B8-4EAA-8F33-BA567834A2C3
StatusCode	integer	The status code.	200

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.