ListSensitiveColumns - Data Management - Alibaba Cloud Documentation Center

Queries sensitive fields in a table of a database.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	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.	3
SchemaName	string	No	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.	test_schema
TableName	string	No	The name of the table. You can call the ListTables operation to query the ID of the table.	test_table
ColumnName	string	No	The name of the field. You can call the ListColumns operation to query the name of the field.	test_column
SecurityLevel	string	No	The sensitivity level of the field. Valid values: SENSITIVE: medium sensitivity level CONFIDENTIAL: high sensitivity level	SENSITIVE
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	100
DbId	long	No	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.	1860
Logic	boolean	No	Specifies whether the database is a logical database. Valid values: true: The database is a logical database. false: The database is a physical database.	false

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of returned entries.	1
RequestId	string	The ID of the request.	09D82FD7-F87F-59EF-AA82-AEF71B09E306
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
SensitiveColumnList	array<object>	The sensitive fields.
SensitiveColumn	object
ColumnName	string	The name of the field.	test_column
TableName	string	The name of the table.	test_table
SecurityLevel	string	The sensitivity level of the field. Valid values: SENSITIVE CONFIDENTIAL	SENSITIVE
ColumnCount	long	The number of sensitive fields.	1
SchemaName	string	The name of the database.	test_schema
FunctionType	string	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.	DEFAULT
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "09D82FD7-F87F-59EF-AA82-AEF71B09E306",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "SensitiveColumnList": {
    "SensitiveColumn": [
      {
        "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 Service error codes.

Change history

Change time	Summary of changes	Operation

No change history