Help Center/ Data Security Center/ API Reference/ API Description/ Static Data Masking/ Querying Encryption and Masking Configurations
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Encryption and Masking Configurations

Function

This API is used to query the encryption and masking configurations based on the project ID.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/sdg/server/mask/algorithms/encryption-configurations

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

algorithm_type

Yes

String

Encryption algorithm type.

configuration_name

No

String

Configuration name.

limit

Yes

Integer

Number of records on each page.

offset

Yes

Integer

Pagination offset.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

access_permission

Boolean

Whether you have the access permission

configuration_list

Array of Configuration objects

Encryption and masking configuration list

total

Integer

Total number of encryption and masking configurations.
Table 4 Configuration

Parameter

Type

Description

algorithm_name

String

Name of the encryption and masking algorithm.

algorithm_type

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.

configuration_name

String

Name of the encryption and masking configuration.

enable_rotate

Boolean

Whether to enable key rotation.

encrypt_mode

String

Encryption mode, the value contains 1 to 256 characters.

filling_method

String

Padding method, which is used for encryption and masking.

id

String

Unique ID of the encryption and masking configuration.

kms_context

KmsContext object

KMS context information.

mask_task_num

Integer

Number of masking tasks.

rotate_period

Integer

Key rotation period (days)
Table 5 KmsContext

Parameter

Type

Description

kms_key_alias

String

Alias of the KMS key

kms_key_id

String

Unique ID of the KMS key

kms_region

String

Region where the KMS is located

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.

Parent topic: Static Data Masking