文档首页/ 数据安全中心 DSC/ API参考/ API/ 数据库脱敏/ 获取任务列表 - ListDbMaskTask
更新时间:2026-10-20 GMT+08:00
分享

获取任务列表 - ListDbMaskTask

功能介绍

获取任务列表

调用方法

请参见如何调用API。

授权信息

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

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

URI

GET /v1/{project_id}/sdg/server/mask/dbs/templates/{template_id}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$"

默认取值:

不涉及

template_id

是

String

参数解释:

模板ID,标识一个数据库脱敏模板,用于查询该模板下的所有脱敏任务。可通过调用查询脱敏模板列表接口获取,或登录数据安全中心控制台的任务模板页面查看。

约束限制:

模板ID须为真实存在的模板

取值范围:

字符串类型,长度1~64字符

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

workspace_id

否

String

参数解释:

工作空间ID,标识查询任务所属的工作空间,用于限定查询某一工作空间下的脱敏任务。可通过查询工作空间列表接口获取,或登录数据安全中心控制台的工作空间页面查看。

约束限制:

非必填,不指定时查询全部工作空间下的任务

取值范围:

字符串类型,长度1~256字符

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

tasks

Array of DBMaskTaskInfo objects

参数解释:

脱敏任务列表

取值范围:

不涉及

tasks项

不涉及

取值范围:

不涉及

不涉及'

表5 DBMaskTaskInfo

参数

参数类型

描述

id

String

参数解释:

资源ID,唯一标识

取值范围:

不涉及

task_template_id

String

参数解释:

数据库脱敏任务信息ID

取值范围:

不涉及

db_type

String

参数解释:

数据库类型

取值范围:

不涉及

start_time

Long

参数解释:

数据库脱敏任务开始时间,任务计划或实际开始执行的时间点,毫秒级Unix时间戳。

取值范围:

整数,0~9223372036854775807

end_time

Long

参数解释:

数据库脱敏任务结束时间,任务执行结束的时间点,毫秒级Unix时间戳。

取值范围:

整数,0~9223372036854775807

run_status

String

参数解释:

运行状态

取值范围:

不涉及

progress

Integer

参数解释:

执行进度,表示数据库脱敏任务的执行进度百分比,取值0~100,100表示任务执行完成。

取值范围:

整数,0~100

type

String

参数解释:

脱敏任务类型

取值范围:

不涉及

error_msg

String

参数解释:

错误信息

取值范围:

不涉及

execute_line

Integer

参数解释:

执行行数

取值范围:

不涉及

请求示例

获取任务列表

/v1/2b31ed520abcd1234ebedb6e57123456/sdg/server/mask/dbs/templates/0b02392f3d0042bd8f80376485d9b7d8/tasks

响应示例

状态码:200

{
  "total" : 1,
  "tasks" : [ {
    "id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "task_template_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c",
    "db_type" : "MYSQL",
    "start_time" : 1700000000000,
    "end_time" : 1700000600000,
    "run_status" : "FINISHED",
    "progress" : 100,
    "type" : "DB",
    "error_msg" : "任务执行成功",
    "execute_line" : 1000
  } ]
}

SDK代码示例

SDK代码示例如下。

Java

 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
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.*;


public class ListDbMaskTaskSolution {

    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();
        ListDbMaskTaskRequest request = new ListDbMaskTaskRequest();
        request.withTemplateId("{template_id}");
        try {
            ListDbMaskTaskResponse response = client.listDbMaskTask(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

 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
# 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 = ListDbMaskTaskRequest()
        request.template_id = "{template_id}"
        response = client.list_db_mask_task(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

 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
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.ListDbMaskTaskRequest{}
	request.TemplateId = "{template_id}"
	response, err := client.ListDbMaskTask(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询成功

错误码

请参见错误码。

相关文档