SubmitCopyrightExtractJob - Intelligent Media Services - Alibaba Cloud Documentation Center

Submits a job that extracts a copyright watermark.

Operation description

This operation is supported only in the China (Shanghai) and China (Beijing) regions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:SubmitCopyrightExtractJob	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Input	object	Yes	The source video file from which to extract the watermark. Note The OSS object or media asset must reside in the same region as the IMS service region.
Type	string	Yes	The type of the source file. Valid values: OSS: an OSS object. Media: a media asset.	OSS
Media	string	Yes	The specific information for the input file, which can be an OSS URL or a media asset ID. OSS URL formats: 1. oss://bucket/object 2. http(s)://bucket.oss-[regionId].aliyuncs.com/object where bucket specifies an OSS bucket that resides in the same region as the job, and object specifies the object path in OSS.	oss://bucket/object
UserData	string	No	The custom data, which can be up to 1,024 bytes in size.	123
Params	string	No	Additional parameters for the watermark job, provided as a JSON string. Supported parameter: algoType: The algorithm type. Defaults to v1. The extraction algorithm must match the one used for embedding. v1: Copyright watermark extraction algorithm for long videos. v2: Copyright watermark extraction algorithm for short videos.	{"algoType":"v2"}

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Data	object	The data returned.
JobId	string	The job ID.	bfb786c63****4d80648792021eff90
Message	string	The message returned.	ok
RequestId	string	The ID of the request.	**2876-6263-4B75-8F2C-CD0F7FCF**
StatusCode	long	The status code.	200

Examples

Sample success responses

JSONformat

{
  "Data": {
    "JobId": "bfb786c63****4d80648792021eff90"
  },
  "Message": "ok",
  "RequestId": "****2876-6263-4B75-8F2C-CD0F7FCF****",
  "StatusCode": 200
}

Error codes

For a list of error codes, visit the Service error codes.