Retrieve Sensitive Columns

Use this API to retrieve sensitive column settings in a specified data source. Narrow the query by database, schema, and table to verify recognition results or audit sensitive data configuration.

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

Request Method: GET

Request Parameters

Parameter	Type	Required	Description	Example
datasourceId	String	Yes	Data source ID. Call Retrieve Data Source List to query the ID.	ds-xxxyyy
databaseName	String	No	Database name.	backup_test
schemaName	String	No	Schema name.	public
tableName	String	No	Table name.	test_table
current	Integer	No	Current page number, starting from 1. Default value: 1.	1
pageSize	Integer	No	Page size. Default value: 10.	10

Request Example

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

{
  "datasourceId": "ds-xxxyyy",
  "databaseName": "backup_test",
  "tableName": "test_table",
  "current": 1,
  "pageSize": 10
}

Response Parameters

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

The fields of each sensitive column detail are as follows:

Parameter	Type	Description
databaseName	String	Database name of the sensitive column.
schemaName	String	Schema name of the sensitive column.
tableName	String	Table name of the sensitive column.
columnName	String	Sensitive column name.
dataTypeId	String	Data type ID.
algorithmId	Integer	Masking algorithm ID.
sensitiveLevel	Integer	Sensitive level. Valid values: 0~5. 0 indicates a non-sensitive field.

Successful Response Example

{
  "success": true,
  "requestId": "Ug9a7WEH-iophcCDnloky9ZNdnql7LPT",
  "data": [
    {
      "databaseName": "backup_test",
      "tableName": "test_table",
      "columnName": "id",
      "sensitiveLevel": 0,
      "dataTypeId": "0",
      "algorithmId": 1
    }
  ],
  "current": 1,
  "pageSize": 10,
  "total": 1
}

Result

A successful response returns the matching sensitive column records and their assigned data type, masking algorithm, and sensitive level. If no records match the filters, the data array is empty.