SubmitCopyrightExtractJob

Updated at:

Submits a copyright watermark extraction job.

Operation description

  • Currently, digital watermarking-related API operations are only supported in the China (Shanghai) and China (Beijing) regions.

  • This is an asynchronous API operation. After you submit a node, a node ID is returned. The node is not completed at this time and is queued to execute asynchronously in the background. The final result is sent through a callback notification. You can also call the Query copyright watermark extraction jobs operation to query the node 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 None

Request parameters

Parameter

Type

Required

Description

Example

Input

string

No

The input Object Storage Service (OSS) URL of the file from which the copyright watermark is to be extracted.

{"Bucket":"example","Location":"oss-cn-shanghai","Object":"example.mp4"}

CallBack

string

No

The callback URL for the node result. 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 watermark job parameters in JSON string format. The following parameters are supported:

  • algoType: the algorithm type. Default value: v1.
    • v1: long video copyright extraction.

    • v2: short video copyright extraction.

{"algoType":"v1"}

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

05F8B913-E9F3-4A6F-9922-48CADA0FFAAD

Message

string

The returned message.

ok

Data

object

The returned 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.