CreateWatermarkExtractTask

Updated at:

Submits an image or video file to extract a dark watermark and returns a task ID.

Operation description

Request description

  • FileUrl must be a publicly accessible HTTP/HTTPS URL. External files are not supported. Only file URLs accessible from the Chinese mainland public network are supported. Upload the file to an Alibaba Cloud OSS bucket in a region within the Chinese mainland first, and then use the presigned URL of the file as the input parameter of this operation. References: How do I obtain the URL of one or more objects?

  • FileType must be the same as the one used during embedding: Make sure that the file type (image or video) for extraction is the same as the file type used when the watermark was embedded.

  • File specification limits: Video files must be no longer than 10 minutes and no larger than 100 MB. Image files must also be no larger than 100 MB.

  • Processing time: Approximately equal to the actual playback duration of the file. For example, a 10-second video takes approximately 10 seconds to complete the watermark fetch procedure.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

ClientToken

string

No

A reserved idempotency field. Idempotency is not supported. Passing in a value does not cause an error, but it does not produce an idempotency effect.

5A2CFF0E-5718-45B5-9D4D-70B3FF3898

FileType

string

Yes

The file type. Valid values: image and video. The value must be the same as the FileType used when the watermark was embedded.

video

FileUrl

string

No

The URL of the file from which the watermark is to be extracted. Images and videos are supported. Only the http/https protocol is supported. Videos must be no longer than 10 minutes and no larger than 100 MB.

https://example.com/demo.mp4

Reserved

string

No

A reserved field. No valid values are available. Do not pass in this parameter.

""

Response elements

Element

Type

Description

Example

object

Schema of Response

Code

string

The business error code. OK is returned if the request is successful.

OK

HttpStatusCode

string

The HTTP status code. 200 is returned if the request is successful.

200

Message

string

The additional information. "success" is returned if the request is successful.

success

RequestId

string

The request ID.

A1B2C3D4-E5F6-7890-ABCD-EF1234567890

Success

boolean

Indicates whether the request is successful.

true

TaskId

string

The dark watermark extraction task ID, which is used to call GetWatermarkExtractTaskResult to query the result.

f47ac10b-58cc-4372-a567-0e02b2c3d479

Examples

Success response

JSON format

{
  "Code": "OK",
  "HttpStatusCode": "200",
  "Message": "success",
  "RequestId": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890",
  "Success": true,
  "TaskId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Error codes

HTTP status code

Error code

Error message

Description

400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.