文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据脱敏/ 数据脱敏 - BatchAddDataMask
更新时间:2026-10-20 GMT+08:00
分享

数据脱敏 - BatchAddDataMask

功能介绍

  • 功能介绍:对结构化数据执行同步脱敏。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/data/mask

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于标识用户所属的项目,实现权限控制和资源隔离。获取方法请参见获取项目ID和名称。

约束限制:

不涉及

取值范围:

长度为32个字符

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

mask_strategies

是

Array of Strategy objects

参数解释:

脱敏策略列表,数组每个元素为MaskStrategies对象,包含脱敏策略名称、脱敏算法名称及脱敏算法参数等信息(定义参见Strategy)

约束限制:

策略名称不可重复,脱敏策略数最多100个

取值范围:

不涉及

默认取值:

不涉及

data

是

Array of Map<String,String> objects

参数解释:

待脱敏数据行列表,数组每个元素为Map<String,String>键值对,key为字段名称,value为字段值

约束限制:

数据行最多1000条

取值范围:

不涉及

默认取值:

不涉及

表4 Strategy

参数

是否必选

参数类型

描述

name

是

String

参数解释:

策略名称,脱敏策略的唯一名称

约束限制:

同一请求内策略名称不可重复

取值范围:

字符串类型,长度1~128个字符

默认取值:

不涉及

algorithm

是

String

参数解释:

脱敏算法,指定数据脱敏使用的算法名称

约束限制:

不涉及

取值范围:

SHA256-哈希脱敏(SHA256)

SHA512-哈希脱敏(SHA512)

AES-AES加密脱敏

PRESNM-保留前n后m字符

MASKNM-掩码中间n-m字符

PRESXY-保留前x后y字符

MASKXY-掩码中间x-y字符

SYMBOL-符号替换

KEYWORD-关键字替换

NUMERIC-数值泛化

默认取值:

不涉及

parameters

否

Map<String,String>

参数解释:

脱敏算法参数,Map<String,String>键值对,key为算法参数名称,value为对应的参数值,具体参数取决于所选脱敏算法

约束限制:

按算法不同要求,如AES需key和len,SYMBOL需direction和symbol,KEYWORD需key和target

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

masked_data

Array of Map<String,String> objects

参数解释:

脱敏后数据行列表,数组每个元素为Map<String,String>键值对,key为字段名称,value为脱敏后的字段值

取值范围:

不涉及

请求示例

对数据执行同步脱敏,使用SHA256算法脱敏手机号码列。

{
  "mask_strategies" : [ {
    "name" : "strategy-demo",
    "algorithm" : "SHA256"
  } ],
  "data" : [ {
    "phone" : 13800000000
  } ]
}

响应示例

状态码:200

{
  "masked_data" : [ {
    "phone" : "51******00"
  } ]
}

SDK代码示例

SDK代码示例如下。

Java

对数据执行同步脱敏,使用SHA256算法脱敏手机号码列。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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("phone", "13800000000");
        List<Map<String, Object>> listbodyData = new ArrayList<>();
        listbodyData.add(listDataData);
        List<MaskStrategies> listbodyMaskStrategies = new ArrayList<>();
        listbodyMaskStrategies.add(
            new MaskStrategies()
                .withName("strategy-demo")
                .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

对数据执行同步脱敏,使用SHA256算法脱敏手机号码列。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# 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 = {
            "phone": "13800000000"
        }
        listDatabody = [
            listDataData
        ]
        listMaskStrategiesbody = [
            MaskStrategies(
                name="strategy-demo",
                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

对数据执行同步脱敏,使用SHA256算法脱敏手机号码列。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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{}{
        "phone": "13800000000",
    }
	var listDatabody = []map[string]interface{}{
        listDataData,
    }
	var listMaskStrategiesbody = []model.MaskStrategies{
        {
            Name: "strategy-demo",
            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的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档