Call the ListSensitiveColumns to search for sensitive fields.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListSensitiveColumns

The operation that you want to perform. Valid values: ListSensitiveColumns .

Tid Long Yes -1

The ID of the tenant.

Note The tenant ID is obtained by hovering over the avatar. For more information, see Tenant ID and Tenant .
SchemaName String No test

The name of the database.

TableName String No test

The name of the table.

ColumnName String No test

The name of the column.

SecurityLevel String No SENSITIVE

The sensitivity level of fields. Valid values:

PageNumber Integer No 1

The page that is returned.

PageSize Integer No 10

The amount of data on each page.

RegionId String No cn-hangzhou

The Region parameter.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The returned message.

RequestId String 0E714EF1-E617-4BBC-A3D2-9552063BA942

The ID of the request.

SensitiveColumnList Array of SensitiveColumn

The list of sensitive fields.

ColumnCount Long 1

The number of fields.

ColumnName String test

The name of the column.

FunctionType String DEFAULT

The type of the masking algorithm. For more information, see:

  • DEFAULT: full masking (DEFAULT)
  • FIX_POS: fixed position
  • FIX_CHAR: the fixed characters.
SchemaName String test

The name of the database.

SecurityLevel String SENSITIVE

The level of the sensitive field.

TableName String test

The name of the table.

Success Boolean true

Indicates whether the request was successful.

TotalCount Long 10

The total number of returned entries.


Sample requests

     http(s)://[Endpoint]/? Action=ListSensitiveColumns &Tid=-1 &<common request parameters> 

Sample success responses

XML format

     <TotalCount>5</TotalCount> <RequestId>0E714EF1-E617-4BBC-A3D2-9552063BA942</RequestId> <SensitiveColumnList> <SensitiveColumn> <TableName>yuyang_test</TableName> <ColumnName>c1</ColumnName> <ColumnCount>0</ColumnCount> <SecurityLevel>SENSITIVE</SecurityLevel> <SchemaName>testdb</SchemaName> </SensitiveColumn> <SensitiveColumn> <TableName>yuyang_test_luanma</TableName> <ColumnName>c1</ColumnName> <ColumnCount>0</ColumnCount> <SecurityLevel>SENSITIVE</SecurityLevel> <SchemaName>testdb</SchemaName> </SensitiveColumn> <SensitiveColumn> <TableName>yuyang_test</TableName> <ColumnName>id</ColumnName> <ColumnCount>0</ColumnCount> <SecurityLevel>SENSITIVE</SecurityLevel> <SchemaName>testdb</SchemaName> </SensitiveColumn> <SensitiveColumn> <TableName>yuyang_test_luanma</TableName> <ColumnName>id</ColumnName> <ColumnCount>0</ColumnCount> <SecurityLevel>SENSITIVE</SecurityLevel> <SchemaName>testdb</SchemaName> </SensitiveColumn> <SensitiveColumn> <TableName>yuyang_test_json</TableName> <ColumnName>id</ColumnName> <ColumnCount>0</ColumnCount> <SecurityLevel>CONFIDENTIAL</SecurityLevel> <SchemaName>test_demo</SchemaName> </SensitiveColumn> </SensitiveColumnList> <Success>true</Success> 

JSON Format

     { "TotalCount": 5, "RequestId": "0E714EF1-E617-4BBC-A3D2-9552063BA942", "SensitiveColumnList": { "SensitiveColumn": [ { "TableName": "yuyang_test", "ColumnName": "c1", "ColumnCount": 0, "SecurityLevel": "SENSITIVE", "SchemaName": "testdb" }, { "TableName": "yuyang_test_luanma", "ColumnName": "c1", "ColumnCount": 0, "SecurityLevel": "SENSITIVE", "SchemaName": "testdb" }, { "TableName": "yuyang_test", "ColumnName": "id", "ColumnCount": 0, "SecurityLevel": "SENSITIVE", "SchemaName": "testdb" }, { "TableName": "yuyang_test_luanma", "ColumnName": "id", "ColumnCount": 0, "SecurityLevel": "SENSITIVE", "SchemaName": "testdb" }, { "TableName": "yuyang_test_json", "ColumnName": "id", "ColumnCount": 0, "SecurityLevel": "CONFIDENTIAL", "SchemaName": "test_demo" } ] }, "Success": true } 

Error code

Go to the Error Center For more information, see error codes.