Help Center/ Data Security Center/ API Reference/ API Description/ Static Data Masking/ Querying the Masking Algorithm List of a Specified Type
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Masking Algorithm List of a Specified Type

Function

This API is used to query the masking algorithm list of a specified type.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/mask/algorithms

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page.

name

No

String

Algorithm name (for filtering)

offset

No

Integer

Pagination offset.

type

No

String

Algorithm type (for filtering)

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

algorithms

Array of ResponseAlgorithm objects

List of masking algorithms, including all supported masking algorithms.

total

Long

Total number of masking algorithms.
Table 4 ResponseAlgorithm

Parameter

Type

Description

algorithm

String

Unique identifier of the masking algorithm.

algorithm_id

String

Unique ID of the masking algorithm.

algorithm_name

String

Name of the masking algorithm.

algorithm_name_en

String

English name of the masking algorithm

category

String

Category of the masking algorithm, which can be built-in, copied built-in, or custom.

data

String

Data content processed by the masking algorithm.

parameter

String

Configuration parameters of the masking algorithm

processed_data

String

Data content after masking

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