SubmitCopyrightExtractJob-阿里云帮助中心

Operation description

Currently, digital watermarking operations are supported only in the China (Shanghai) and China (Beijing) regions.
This is an asynchronous operation. After you submit a request, the system returns a job ID and queues the job for background processing. You can obtain the final result through a callback notification, or call the QueryCopyrightExtractJob 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:SubmitCopyrightExtractJob

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Input	string	No	The OSS URL of the input file.	{"Bucket":"example","Location":"oss-cn-shanghai","Object":"example.mp4"}
CallBack	string	No	The callback URL for the job result. Only HTTP URLs are supported.	http://example.com/callback
Url	string	No	A publicly accessible URL for the video. If this parameter is specified, this URL is used as the job input and takes precedence over the Input parameter.	http://www.example.com/video/test.mp4
UserData	string	No	The custom data. The maximum length is 1,024 bytes.	123
Params	string	No	The parameters for the watermarking job, specified as a JSON string. It supports the following parameter: `algoType`: The algorithm to use. Default value: v1. `v1`: For long-form videos. `v2`: For short-form videos.	{"algoType":"v1"}

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	05F8B913-E9F3-4A6F-9922-48CADA0FFAAD
Message	string	The response message.	ok
Data	object	The response data.
JobId	string	The job ID.	ebbfe90c63b54ed4b61acb2f6c44****
StatusCode	integer	The status code.	200

Examples

Success response

JSON format

{
  "RequestId": "05F8B913-E9F3-4A6F-9922-48CADA0FFAAD",
  "Message": "ok",
  "Data": {
    "JobId": "ebbfe90c63b54ed4b61acb2f6c44****"
  },
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.