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

Operation description

Digital watermarking API operations are currently supported only in the China (Shanghai) and China (Beijing) regions.
This is an asynchronous API operation. After you submit a job, a job ID is returned. The job is not completed immediately and is queued for asynchronous execution in the background. The final result is sent through a callback notification. You can also actively query the job status by calling the Query a copyright watermark extraction job 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:SubmitCopyrightExtractJob

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Input	object	Yes	The video file from which the watermark is to be extracted. Note The region of the OSS file or media asset must be the same as the region of the current IMS instance.
Type	string	Yes	The type of the input file. Valid values: OSS: the URL of an OSS file. Media: the ID of a media asset.	OSS
Media	string	Yes	The information about the input file. Both OSS URLs and media asset IDs are supported. The OSS URL must be in one of the following formats: oss://bucket/object http(s)://bucket.oss-[regionId].aliyuncs.com/object where bucket is the name of the OSS bucket that resides in the same region as the current project, and object is the file path.	oss://bucket/object
UserData	string	No	The custom user data. The maximum length is 1,024 bytes.	123
Params	string	No	The watermark job parameters in JSON string format. The following parameters are supported: algoType: the algorithm type. Default value: v1. The extraction algorithm type must be the same as the algorithm type used for embedding. v1: the copyright extraction API operation for long videos. v2: the copyright extraction API operation for short videos.	{"algoType":"v2"}

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.