ExecDatamask - Data Security Center - Alibaba Cloud Documentation Center

Dynamically de-identifies sensitive data.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	long	Yes	The ID of the de-identification template. The ID is generated after you create the de-identification template in the Data Security Center (DSC) console. You can choose Data desensitization > Desensitization Template in the left-side navigation pane and obtain the ID of the de-identification template from the Desensitization Template page. If you select Field name as the matching mode of the template, DSC matches data based on the columns specified by the dataHeaderList parameter in the Data parameter. If you select Sensitive type as the matching mode of the template, DSC matches data based on the sensitive data detection rules specified by the ruleList parameter in the Data parameter.	1
Data	string	Yes	The sensitive data to be de-identified. The value is a JSON string that contains the following parameters: dataHeaderList: the names of the columns in which data needs to be de-identified. Specify the column names in accordance with the order of data that needs to be de-identified. dataList: the data that needs to be de-identified. ruleList: the IDs of sensitive data detection rules used to detect data that needs to be de-identified. Specify the rule IDs in accordance with the order of data that needs to be de-identified. Each ID identifies a sensitive data detection rule that is used to detect a type of sensitive data. You can call the DescribeRules operation to query the IDs of sensitive data detection rules.	{"dataHeaderList":["name","age"],"dataList":[["lily",18],["lucy",17]],"ruleList":[1002,null]}
FeatureType	integer	No	This parameter is deprecated.	1
Lang	string	No	The language of the content within the request and response. Default value: zh_cn. Valid values: zh_cn: Simplified Chinese en_us: English	zh_cn

Response parameters

Parameter	Type	Description	Example
	object
Data	string	The de-identified data, which is described in a JSON string. The JSON string contains the following parameters: dataHeaderList: the names of columns that contain the de-identified data. dataList: the de-identified data. The column order of the de-identified data is the same as that indicated by the dataHeaderList parameter. ruleList: the IDs of sensitive data detection rules.	{"dataHeaderList":["name","age"],"dataList":[["l*",18],["l*",17]],"ruleList":[1002,null]}
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	813BA9FA-D062-42C4-8CD5-11A7640B96E6

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-04-11	API Description Update	View Change Details
2024-03-25	The request parameters of the API has changed	View Change Details