SubmitDigitalWatermarkExtractJob - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Operation description

Before you call this operation, make sure that you understand the billing methods and pricing for ApsaraVideo VOD. The digital watermark feature is a paid service, and you are charged for both generating and extracting digital watermarks. For more information about billing, see Digital watermark billing.
This operation is supported only in the following regions: China (Shanghai) and China (Beijing).
Before you submit a digital watermark extraction job, make sure that the following conditions are met:
- The video from which you want to extract the watermark is uploaded to ApsaraVideo VOD.
- The video from which you want to extract the watermark is longer than 6 minutes.
After you submit a digital watermark extraction job, you can call the GetDigitalWatermarkExtractResult operation to query the job result.

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

vod:SubmitDigitalWatermarkExtractJob

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaId	string	Yes	The ID of the video from which you want to extract the watermark. You can specify only one video ID. You can obtain the video ID in one of the following ways: Log on to the ApsaraVideo VOD console. In the navigation pane, choose Media Files > Audio/Video to view the video ID. Call the SearchMedia operation. The video ID is the value of the VideoId parameter in the response.	0222e203cf80f9c22870a4d2c****
ExtractType	string	Yes	The type of the watermark that you want to extract. Valid values: TraceMark: tracing watermark. CopyrightMark: copyright watermark.	TraceMark

Response elements

Element	Type	Description	Example
	object
JobId	string	The ID of the watermark extraction job. You can use this ID to call the GetDigitalWatermarkExtractResult operation.	ad90a501b1b9472374ad005046****
RequestId	string	The ID of the request.	04F0F334-1335-436C-****-6C044FE73368

Examples

Success response

JSON format

{
  "JobId": "ad90a501b1b9472374ad005046****",
  "RequestId": "04F0F334-1335-436C-****-6C044FE73368"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.