
# 对数据进行脱敏 - BatchAddDataMask
#### 功能介绍
对数据进行脱敏
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
POST /v1/{project_id}/data/mask
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述   |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                        |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。通过调用IAM服务"获取用户Token接口"获取（响应消息头中X-Subject-Token的值） |
   
表3请求Body参数 
| 参数              | 是否必选 | 参数类型                                                                         | 描述                              |
|:---|:---|:---|:---|
| mask_strategies | 是    | Array of [MaskStrategies] objects | 脱敏策略列表，每一个策略对应一个字段，脱敏策略数最多100个。 |
| data            | 是    | Array of Map\<String,String\> objects                                        | 数据列表。                           |
   
 表4MaskStrategies 
| 参数         | 是否必选 | 参数类型                 | 描述                      |
|:---|:---|:---|:---|
| name       | 是    | String               | 需要脱敏的字段名称，最大支持长度256。    |
| algorithm  | 是    | String               | 脱敏算法名称，详情见附录"动态脱敏策略配置"。 |
| parameters | 否    | Map\<String,Object\> | 脱敏算法参数，详情见附录"动态脱敏策略配置"。 |
   
#### 响应参数
**状态码：200**
表5响应Body参数 
| 参数          | 参数类型                            | 描述                     |
|:---|:---|:---|
| masked_data | Array of Map\<String,\> objects | 脱敏后的数据的数据列表，结构与请求中结构相同 |
   
**状态码：400**
表6响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误信息 |
   
#### 请求示例
脱敏策略列表中对字段col使用KEYWORD脱敏算法，将指定关键字keyword替换为target。
```
POST https://{endpoint}/v1/{project_id}/data/mask
{
  "mask_strategies" : [ {
    "name" : "col",
    "algorithm" : "SHA256"
  } ],
  "data" : [ {
    "col" : "test1111"
  } ]
}
```
#### 响应示例
**状态码：200**
脱敏成功
```
{
  "masked_data" : [ {
    "col" : "XXXXXX"
  } ]
}
```
**状态码：400**
无效请求
```
{
  "error_code" : "DSC.00000004",
  "error_msg" : "Invalid parameter"
}
```
#### SDK代码示例
SDK代码示例如下。
#### Java
脱敏策略列表中对字段col使用KEYWORD脱敏算法，将指定关键字keyword替换为target。
```
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dsc.v1.region.DscRegion;
import com.huaweicloud.sdk.dsc.v1.*;
import com.huaweicloud.sdk.dsc.v1.model.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.util.HashMap;
public class BatchAddDataMaskSolution {
    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";
        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);
        DscClient client = DscClient.newBuilder()
                .withCredential(auth)
                .withRegion(DscRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchAddDataMaskRequest request = new BatchAddDataMaskRequest();
        DynamicDataMask body = new DynamicDataMask();
        Map<String, Object> listDataData = new HashMap<>();
        listDataData.put("col", "test1111");
        List<Map<String, Object>> listbodyData = new ArrayList<>();
        listbodyData.add(listDataData);
        List<MaskStrategies> listbodyMaskStrategies = new ArrayList<>();
        listbodyMaskStrategies.add(
            new MaskStrategies()
                .withName("col")
                .withAlgorithm(MaskStrategies.AlgorithmEnum.fromValue("SHA256"))
        );
        body.withData(listbodyData);
        body.withMaskStrategies(listbodyMaskStrategies);
        request.withBody(body);
        try {
            BatchAddDataMaskResponse response = client.batchAddDataMask(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
```
#### Python
脱敏策略列表中对字段col使用KEYWORD脱敏算法，将指定关键字keyword替换为target。
```
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdsc.v1 import *
if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"
    credentials = BasicCredentials(ak, sk, projectId)
    client = DscClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DscRegion.value_of("<YOUR REGION>")) \
        .build()
    try:
        request = BatchAddDataMaskRequest()
        listDataData = {
            "col": "test1111"
        }
        listDatabody = [
            listDataData
        ]
        listMaskStrategiesbody = [
            MaskStrategies(
                name="col",
                algorithm="SHA256"
            )
        ]
        request.body = DynamicDataMask(
            data=listDatabody,
            mask_strategies=listMaskStrategiesbody
        )
        response = client.batch_add_data_mask(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
```
#### Go
脱敏策略列表中对字段col使用KEYWORD脱敏算法，将指定关键字keyword替换为target。
```
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/region"
)
func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"
    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()
    if err != nil {
        fmt.Println(err)
        return
    }
    hcClient, err := dsc.DscClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()
    if err != nil {
        fmt.Println(err)
        return
    }
    client := dsc.NewDscClient(hcClient)
    request := &model.BatchAddDataMaskRequest{}
var listDataData = map[string]interface{}{
        "col": "test1111",
    }
var listDatabody = []map[string]interface{}{
        listDataData,
    }
var listMaskStrategiesbody = []model.MaskStrategies{
        {
            Name: "col",
            Algorithm: model.GetMaskStrategiesAlgorithmEnum().SHA256,
        },
    }
request.Body = &model.DynamicDataMask{
Data: listDatabody,
MaskStrategies: listMaskStrategiesbody,
}
response, err := client.BatchAddDataMask(request)
if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}
```
#### 更多
更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DSC/sdk?api=BatchAddDataMask)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 200 | 脱敏成功 |
| 400 | 无效请求 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。
