Help Center/ Data Security Center/ API Reference/ API Description/ Static Data Masking/ Querying the Database Masking Task Details
Updated on 2026-01-13 GMT+08:00

Querying the Database Masking Task Details

Function

This API is used to query details about a specified database masking task.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique project ID.

template_id

Yes

String

Task ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

create_time

Long

Time when the database masking task is created.

data_dest

Array of DataDest objects

Target data configuration list of the database masking task.

data_source

Array of DataSource objects

Source data configuration list of the database masking task.

db_type

String

Database type, such as MySQL and PostgreSQL.

increment_key

String

Incremental key of the database masking task, which is used for incremental processing.

mask_ratio

Integer

Masking ratio of the database masking task.

scan_template_id

String

Unique ID of a scan task.

status

Integer

Status of the database masking task, the value can be Enabled or Disabled.

strategy

Array of Strategy objects

Masking policies of the database masking task

task_source

String

Task source ID.

template_id

String

Unique ID of the database masking task.

template_name

String

Name of the database masking task.

trigger_time

String

Time when the database masking task is triggered.

type

String

Type of the database masking task.

Table 3 DataDest

Parameter

Type

Description

data_dest_id

String

Unique ID of the data target.

db_name

String

Database name

dest_ins_id

String

Unique ID of the target instance.

dst_asset_id

String

Unique ID of the target instance.

dst_obs_bucket_name

String

Name of the target OBS bucket.

dst_obs_path

String

Target OBS path

index_name

String

Index name

schema

String

Database mode

table_name

String

Database table name.

type_name

String

Type of a data target.

Table 4 DataSource

Parameter

Type

Description

db_type

String

Database type of the data source, including OBS, DB, BIGDATA, MRS_HIVE, DWS, ES, Hive, Hbase, and DLI.

ins_id

String

Unique ID of the data source instance.

Table 5 Strategy

Parameter

Type

Description

algorithm

String

Encryption and masking algorithm type. The value can be SHA256, SHA512, PRESNM, MASKNM, PRESXY, MASKXY, SYMBOL, KEYWORD, NULL, EMPTY, DATE, NUMERIC, AES, EMBED, SM4, or DECRYPT.

algorithm_id

String

Unique ID of the masking algorithm used by the masking policy.

algorithm_type

String

Type of the masking algorithm, such as hash masking and encryption masking. The value can be MASK_BY_HASH, MASK_BY_ENCRYPT, MASK_BY_OVERWRITE, MASK_BY_KEYWO RDS _EXCHANGE, MASK_BY_NULL, or MASK_BY.

dest_column_name

String

Name of the target column.

dest_field_name

String

Name of the target field.

enable

Boolean

Whether the masking policy is enabled.

parameter

Object

Configuration parameters of the masking policy

rule_name

String

Name of the masking rule.

src_column_name

String

Name of the source column.

src_field_name

String

Name of the source field.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Query result.

401

Unauthorized.

403

Access denied.

404

Resource not found.

Error Codes

See Error Codes.