ExecDatamask - Data Security Center - Alibaba Cloud Documentation Center

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:ExecDatamask

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	integer	Yes	The ID of the data masking template. A template ID is generated after you create a template in the Data Security Center console. You can find the Template ID on the Data Masking > Masking Configuration > Masking Template page. If the matching type of the data masking template is Field Name, the system matches the data against dataHeaderList in Data. If the matching type of the data masking template is Sensitive Data Type, the system matches the data against ruleList in Data.	1
Data	string	Yes	The data that you want to mask. The data must be a string in JSON format and include the following fields: dataHeaderList: The column names of the data. The order of the column names must correspond to the order of the data that you want to mask. dataList: The data that you want to mask. ruleList: A list of sensitive data type IDs. The order of the IDs must correspond to the order of the data that you want to mask. Each ID is a number that represents a sensitive data type. You can call the DescribeRules operation to obtain the IDs.	{"dataHeaderList":["name","age"],"dataList":[["lily",18],["lucy",17]],"ruleList":[1002,null]}
FeatureType	integer	No	This parameter is deprecated.	2
Lang	string	No	The language of the request and response. Default value: zh_cn. Valid values: zh_cn: Simplified Chinese en_us: English (US)	zh_cn

Response elements

Element	Type	Description	Example
	object
Data	string	The data after it is masked. The data is a string in JSON format and includes the following fields: dataHeaderList: The column names of the masked data. dataList: The masked data. The order of the fields corresponds to the order of the column names. ruleList: The sensitive data type IDs. Each ID corresponds to the unique ID of a sensitive data type that is returned by the DescribeRules operation.	{"dataHeaderList":["name","age"],"dataList":[["l*",18],["l*",17]],"ruleList":[1002,null]}
RequestId	string	The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.	813BA9FA-D062-42C4-8CD5-11A7640B96E6

Examples

Success response

JSON format

{
  "Data": "{\"dataHeaderList\":[\"name\",\"age\"],\"dataList\":[[\"l***\",18],[\"l***\",17]],\"ruleList\":[1002,null]}",
  "RequestId": "813BA9FA-D062-42C4-8CD5-11A7640B96E6"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.