CreateDecodeBlindWatermarkTask - Intelligent Media Management

Extracts a blind watermark.

Operation description

Before you use this API, make sure that you understand the billing methods and pricing of Intelligent Media Management (IMM).
Important Asynchronous tasks are not guaranteed to be completed within a specific time frame.
Make sure that a project is created in IMM. For more information, see Create a project.
Make sure the service region and project are the same as those used to add the blind watermark using the EncodeBlindWatermark operation. Otherwise, the watermark cannot be extracted.
The watermark can be extracted even after the image undergoes attacks such as compression, scaling, clipping, and color changes.
This API is compatible with the previous version of the blind watermarking feature. Some parameters are from the previous DecodeBlindWatermark API.
This is an asynchronous API. After a task starts, its information is saved for only 7 days. After this period, the information can no longer be retrieved. Call the GetTask or ListTasks API to retrieve the TaskId and view task information. Alternatively, set the Notification parameter to receive task information through asynchronous notification messages.

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

imm:CreateDecodeBlindWatermarkTask

create

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectName	string	Yes	The project name. For information about how to obtain the project name, see Create a project. Important The project name must be the same as the one used to add the blind watermark with the EncodeBlindWatermark operation. Otherwise, the watermark cannot be extracted.	immtest
SourceURI	string	Yes	The Object Storage Service (OSS) URI of the image. The OSS URI must be in the `oss://<bucket>/<object>` format. `<bucket>` is the name of the OSS bucket that is in the same region as the current project. `<object>` is the full path of the file, including the file name extension.	oss://target/sampleobject.jpg
StrengthLevel	string	No	The watermark extraction level, which controls the extraction precision. A higher level indicates a longer processing time and a better extraction effect. Valid values: low medium high	low
WatermarkType	string	No	The type of the embedded watermark. Valid value: text (Image watermarks are not supported. Therefore, this parameter can only be set to text.) Valid values: text : text	text
TargetURI	string	No	A parameter from the earlier DecodeBlindWatermark API. It specifies the OSS URI where the image is saved after the blind watermark is parsed. The OSS URI must be in the `oss://<bucket>/<object>` format. `<bucket>` is the name of the OSS bucket that is in the same region as the current project. `<object>` is the full path of the file, including the file name extension.	oss://target/targetobject.jpg
ImageQuality	integer	No	A parameter from the earlier DecodeBlindWatermark API. It specifies the quality of the output image. The default value is 90. The value must be in the range of 70 to 100. A higher quality results in a larger image size and better watermark parsing quality.	90
Model	string	No	A parameter from the earlier DecodeBlindWatermark API. It specifies the watermark algorithm model. Valid values include FFT, FFT_FULL, DWT, and DWT_IBG. The default value is FFT. If this parameter is left empty, the new version of the blind watermarking feature is used. Otherwise, the earlier version is used. Valid values: DWT : DWT FFT_FULL : FFT_FULL FFT : FFT DWT_IBG : DWT_IBG	FFT
OriginalImageURI	string	No	A parameter from the earlier DecodeBlindWatermark API. It specifies the OSS URI of the image before the blind watermark was added. This parameter is not required when Model is set to DWT or DWT_IBG. The OSS URI must be in the `oss://<bucket>/<object>` format. `<bucket>` is the name of the OSS bucket that is in the same region as the current project. `<object>` is the full path of the file, including the file name extension.	oss://imm-test/testcases/watermarktestbefore.jpg
Notification	Notification	No	The notification configuration. For more information, click Notification. For the format of asynchronous notification messages, see Asynchronous notification message format.

Response elements

Element	Type	Description	Example
	object	Response parameters
RequestId	string	The ID of the request.	4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE
EventId	string	The event ID.	27C-1jyAP5qQI7RoI8lFFwvMrWtl0ft
TaskId	string	The task ID.	DecodeBlindWatermark-78ac8f3b-59e0-45a6-9b67-32168c3f22b9

Examples

Success response

JSON format

{
  "RequestId": "4A7A2D0E-D8B8-4DA0-8127-EB32C6600ADE",
  "EventId": "27C-1jyAP5qQI7RoI8lFFwvMrWtl0ft",
  "TaskId": "DecodeBlindWatermark-78ac8f3b-59e0-45a6-9b67-32168c3f22b9"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.