Retrieve Masking Algorithm List

Use this API to list masking algorithms that can be applied to sensitive columns. The response helps you select the correct algorithmId before setting sensitive data recognition results through the OpenAPI.

Request URL: /openapi/v1/sensitiveData/algorithm/list

Request Method: GET

Request Parameters

Parameter	Type	Required	Description	Example
algorithmId	Long	No	Masking algorithm ID.	538
current	Integer	No	Current page number, starting from 1. Default value: 1.	1
pageSize	Integer	No	Page size. Default value: 10.	1

Request Example

For request headers, signatures, and GET query construction, see OpenAPI API Documentation.

{
  "current": 1,
  "pageSize": 1
}

Response Parameters

Parameter	Type	Description
success	Boolean	Indicates whether the API call is successful.
requestId	String	Request ID.
data	Array	Masking algorithm detail list.
current	Integer	Current page number.
pageSize	Integer	Page size.
total	Integer	Total number of records.

The fields of each masking algorithm detail are as follows:

Parameter	Type	Description
algorithmId	Integer	Algorithm ID.
name	String	Algorithm name.
description	String	Algorithm description.

Successful Response Example

{
  "success": true,
  "requestId": "Jc4c7PKY-IOPHyYZnLOKm6PEdNQd8LIB",
  "data": [
    {
      "algorithmId": 538,
      "name": "Mask last 4 digits",
      "description": "Mask last 4 digits"
    }
  ],
  "current": 1,
  "pageSize": 1,
  "total": 41
}

Result

A successful response returns a paginated list of masking algorithms. Use the returned algorithmId when you assign a masking rule to a sensitive column.