调用ExecDatamask接口对数据进行动态脱敏。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ExecDatamask

要执行的操作。取值:ExecDatamask

TemplateId Long 1

指定脱敏模板ID。在数据安全中心控制台上创建模板后会生成模板ID,您可以在数据脱敏>脱敏模板页面获取脱敏模板ID

  • 若脱敏模板匹配类型是字段名称,则取Data中的dataHeaderList进行匹配。
  • 若脱敏模板匹配类型是敏感类型,则取Data中的ruleList进行匹配。
Data String {"dataHeaderList":["name","age"],"dataList":[["lily",18],["lucy",17]],"ruleList":[1002,null]}

指定需要脱敏的数据。采用JSON格式的字符串表述,包含以下字段:

  • dataHeaderList:数据的列名,顺序和需要脱敏的数据一一对应。
  • dataList:需要脱敏的数据。
  • ruleList :敏感类型ID列表,顺序和需要脱敏的数据一一对应。

    敏感类型ID是数字,不同的数字代表不同的敏感类型,可通过DescribeRules接口获取。

Lang String zh_cn

设置请求和返回消息的语言类型。默认值为zh_cn。取值

  • zh_cn:简体中文
  • en_us:英文(美国)

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
Data String {"dataHeaderList":["name","age"],"dataList":[["l***",18],["l***",17]],"ruleList":[1002,null]}

脱敏完成后的数据,采用JSON格式的字符串表述。包含以下字段:

  • dataHeaderList:表示脱敏数据的列名。
  • dataList:表示需要脱敏的数据。字段顺序和脱敏数据的列名一致。
  • ruleList : 敏感类型ID。
RequestId String 813BA9FA-D062-42C4-8CD5-11A7640B96E6

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

示例

请求示例

http(s)://[Endpoint]/?Action=ExecDatamask
&Data={"dataHeaderList":["name","age"],"dataList":[["lily",18],["lucy",17]]}
&TemplateId=1
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

访问错误中心查看更多错误码。