Queries sensitive fields in a table of a database.

Debugging

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. Set the value to ListSensitiveColumns.

Tid Long Yes 3

The ID of the tenant.

Note To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the Manage DMS tenants topic.
SchemaName String No test_schema

The name of the database. You can call the SearchDatabase operation to query the name of the database.

Note You can also call the ListDatabases operation to query the name of a physical database and the ListLogicDatabases operation to query the name of a logical database.
TableName String No test_table

The name of the table. You can call the ListTables operation to query the ID of the table.

ColumnName String No test_column

The name of the field. You can call the ListColumns operation to query the name of the field.

SecurityLevel String No SENSITIVE

The sensitivity level of the field. Valid values:

  • SENSITIVE: medium sensitivity level
  • CONFIDENTIAL: high sensitivity level
PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 100

The number of entries to return on each page.

RegionId String No cn-hangzhou

The ID of the region in which DMS is activated. For more information about the valid values of this parameter, see RegionID parameter.

Note Set this parameter to the ID of the region that is in proximity to your applications.
DbId Long No 1860

The ID of the database. You can call the SearchDatabase operation to query the ID of the database.

Note You can also call the ListDatabases operation to query the ID of the physical database and the ListLogicDatabases operation to query the ID of a logical database.
Logic Boolean No false

Specifies whether the database is a logical database. Valid values:

  • true: The database is a logical database.
  • false: The database is a physical database.

Response parameters

Parameter Type Example Description
TotalCount Long 1

The total number of returned entries.

RequestId String 09D82FD7-F87F-59EF-AA82-AEF71B09E306

The ID of the request.

ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

SensitiveColumnList Array of SensitiveColumn

The sensitive fields.

SensitiveColumn
ColumnName String test_column

The name of the field.

TableName String test_table

The name of the table.

SecurityLevel String SENSITIVE

The sensitivity level of the field. Valid values:

  • SENSITIVE
  • CONFIDENTIAL
ColumnCount Long 1

The number of sensitive fields.

SchemaName String test_schema

The name of the database.

FunctionType String DEFAULT

The type of the de-identification algorithm. Valid values:

  • DEFAULT: All characters are masked. This is the default value.
  • FIX_POS: The characters at specific positions are masked.
  • FIX_CHAR: Specific characters are masked.
Success Boolean true

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=ListSensitiveColumns
&Tid=3***
&SchemaName=test_schema
&TableName=test_table
&ColumnName=test_column
&SecurityLevel=SENSITIVE
&PageNumber=1
&PageSize=100
&DbId=1860****
&Logic=false
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListSensitiveColumnsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>09D82FD7-F87F-59EF-AA82-AEF71B09E306</RequestId>
    <SensitiveColumnList>
        <ColumnName>test_column</ColumnName>
        <TableName>test_table</TableName>
        <SecurityLevel>SENSITIVE</SecurityLevel>
        <ColumnCount>1</ColumnCount>
        <SchemaName>test_schema</SchemaName>
        <FunctionType>DEFAULT</FunctionType>
    </SensitiveColumnList>
    <Success>true</Success>
</ListSensitiveColumnsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "09D82FD7-F87F-59EF-AA82-AEF71B09E306",
  "SensitiveColumnList" : [ {
    "ColumnName" : "test_column",
    "TableName" : "test_table",
    "SecurityLevel" : "SENSITIVE",
    "ColumnCount" : 1,
    "SchemaName" : "test_schema",
    "FunctionType" : "DEFAULT"
  } ],
  "Success" : true
}

Error codes

For a list of error codes, visit the API Error Center.