MaskOssImage - Data Security Center - Alibaba Cloud Documentation Center

Operation description

Prerequisites

To use this operation, you must purchase an image masking quota. Each time you call this operation, one unit is deducted from your quota.

QPS limits

The queries per second (QPS) limit for a single user is 10. If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you make API calls at a reasonable rate.

Usage notes

After masking is complete, the masked image is saved to the aliyun_dsc_desensitization folder in the bucket that contains the original image.

For example, if an image is located at exampledir/test.png in a bucket, the masked image is saved as aliyun_dsc_desensitization/exampledir/test.png.

For more information, see https://www.alibabacloud.com/help/zh/dsc/data-security-center/user-guide/picture-desensitization

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

yundun-sddp:MaskOssImage

none

*All Resource

*

acs:ResourceGroupId

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
BucketName	string	Yes	The name of the OSS bucket.	sddp-api-demo-bucket
ObjectKey	string	Yes	The full path of the object in OSS.	dir1/test.png
ServiceRegionId	string	Yes	The region where the bucket is located.	cn-hangzhou
MaskRuleIdList	string	Yes	A comma-separated list of data masking rule IDs. The following list describes the rule IDs: 3000: Images that contain ID card information (the Chinese mainland) 3009: Images that contain license plate information (the Chinese mainland) 3002: Images that contain faces 1002: Names (Simplified Chinese) 1003: Addresses (the Chinese mainland) 4003: Unified Social Credit Code 63009: Images that contain eyes	3000,3002
IsSupportRestore	boolean	No	Specifies whether the masked image can be restored to the original.	true
IsAlwaysUpload	boolean	No	Specifies whether to always upload the processed image. If this parameter is set to false, the image is uploaded only if a masking rule is matched. If this parameter is set to true, the processed image is always uploaded.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	136082B3-B21F-5E9D-B68E-991FFD205D24

Examples

Success response

JSON format

{
  "RequestId": "136082B3-B21F-5E9D-B68E-991FFD205D24"
}

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.