Skip to main content

Set Sensitive Column

Set the sensitive data recognition result for a field in a specified data source.

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

Request Method: POST

Request Parameters

ParameterTypeRequiredDescriptionExample
datasourceIdStringYesData source ID. You can call Retrieve Data Source List to query the ID.ds-xxxyyy
databaseNameStringYesDatabase name.backup_test
schemaNameStringNoSchema name. Required for data sources such as PostgreSQL and SQL Server.public
tableNameStringYesTable name.test_table
columnNameStringYesColumn name.id
catalogIdLongNoData category ID. Default value: 0, indicating the system default data category.0
sensitiveLevelIntegerNoSensitive level. Valid values: 0~5. Default value: 1. 0 indicates a non-sensitive field.0
dataTypeIdStringNoData type ID. Default value: 0, indicating the system default data type.0
algorithmIdLongNoMasking algorithm ID. Default value: 1, indicating the full masking algorithm.1

Request Example

For request headers, signatures, and POST request body construction, see OpenAPI API Documentation.

{
"datasourceId": "ds-xxxyyy",
"databaseName": "backup_test",
"tableName": "test_table",
"columnName": "id",
"catalogId": 0,
"sensitiveLevel": 0,
"dataTypeId": "0",
"algorithmId": 1
}

Response Parameters

ParameterTypeDescription
successBooleanIndicates whether the setting is successful.
requestIdStringRequest ID.

Successful Response Example

{
"success": true,
"requestId": "Od3j1OLL-cijbmZVnfigh0EKdibf6PUU"
}