SubmitCopyrightJob - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Submits a video copyright watermark job.

Operation description

By default, submitting a video copyright watermark job supports only videos that are 3 minutes or longer. If the video is too short, the API call may fail or produce no output. To add a copyright watermark to a short video that is less than 3 minutes long, you can specify this by using the Params parameter. For more information, see the parameter description.
Each API call for submitting a video copyright watermark job adds a watermark to a single video. Submitting multiple videos at the same time is not supported.
Digital watermark-related API operations are currently supported only in the China (Shanghai) and China (Beijing) regions. For more information about limits, see Digital watermarking.
This API operation is an asynchronous operation. After you submit a job, a job ID is returned. The job is not completed at this time and enters the background queue for asynchronous execution. The final result is notified by using a callback. You can also call the Query a video copyright watermark job operation to query the job status.

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

mts:SubmitCopyrightJob

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Input	string	No	The OSS URL of the media file to which you want to add a watermark. Currently, only video files are supported. The value is a JSON object. For more information, see Input details. Note The region of the OSS bucket must be the same as the region where MPS is deployed. Bucket: the name of the OSS bucket for the input file. Location: the region where OSS is deployed. The region must be the same as the region where MPS is deployed. Object: the OSS object to be processed.	{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example.mp4"}
Output	string	Yes	The OSS URL for the output file. The value is a JSON object. Note The region of the OSS bucket must be the same as the region where MPS is deployed.	{"Bucket":"example-bucket","Location":"oss-cn-shanghai","Object":"example_result.mp4"}
Message	string	Yes	The watermark information to be added.	T-Head Semiconductor
StartTime	integer	No	The start time of watermark embedding, in seconds. If you do not specify this parameter, the default value is 0.	0
TotalTime	integer	No	The total duration of watermark embedding, 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 (u channel), 1 (uv channel), and 2 (yuv channel).	2
Description	string	No	The description of the watermark information.	Address: Chuanhe Road, Shangke Road, Pudong New Area, Shanghai
CallBack	string	No	The callback URL for the node result. Currently, only HTTP URLs are supported.	http://example.com/callback
Url	string	No	The video URL that supports public network access. If you specify this parameter, it is preferentially used as the node input. Otherwise, the Input parameter is used.	http://www.example.com/video/test.mp4
UserData	string	No	The custom user data. The maximum length is 1,024 bytes.	123
Params	string	No	The parameters for the watermark job. The value is a JSON string. The following parameters are supported: algoType: the algorithm type. Default value: v1. v1: long video copyright watermark. Only videos longer than 3 minutes are supported. v2: short video copyright watermark.	{"algoType":"v2"}

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.