SubmitImageCopyright-阿里云帮助中心

Operation description

This operation generates a transparent image with a hidden watermark. You can overlay this image on your page content to protect it from unauthorized screenshots. The Params, Output, and Message parameters are required.
This operation is available only in the China (Shanghai) region.
This is an asynchronous API. After you submit a job, the API returns a job ID and queues the job for background processing. The service sends a callback notification with the final 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

mts:SubmitImageCopyright

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Output	string	Yes	The OSS location for the output transparent image watermark. Note The OSS bucket must be in the same region where MPS is activated.	{"Bucket":"abc-test","Location":"oss-cn-shanghai","Object":"out.jpeg"}
Message	string	Yes	The content of the watermark.	平头哥半导体公司
Params	string	Yes	The watermark parameters, provided as a JSON string. This string contains the following fields: `width`: The width of the output image. `height`: The height of the output image. `afa`: The transparency level of the watermark. Valid values: 0 to 255. `type`: The watermark algorithm. Valid values: `0` (for game rendering) and `1` (for general application rendering). `version`: The watermark version. Currently, only the value `0` is supported.	{"width":2999, "height":2999, "afa": 3, "type":1, "version":0}

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	D1D5C080-8E2F-5030-8AB4-13092F17631B
Message	string	The response message.	ok
Data	object	The response data.
JobId	string	The job ID.	bfb786c639894f4d80648792021e****
StatusCode	integer	The status code.	200

Examples

Success response

JSON format

{
  "RequestId": "D1D5C080-8E2F-5030-8AB4-13092F17631B",
  "Message": "ok",
  "Data": {
    "JobId": "bfb786c639894f4d80648792021e****"
  },
  "StatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.