ListSensitiveColumnsDetail - Data Management - Alibaba Cloud Documentation Center

Queries the details of a sensitive field.

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. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	3***
SchemaName	string	Yes	The name of the database. You can call the ListSensitiveColumns operation to obtain the name of the database. Note You can also call the ListDatabases or SearchDatabase operation to obtain the name of a physical database. You can also call the ListLogicDatabases or SearchDatabase operation to obtain the name of a logical database.	SchemaName_test
TableName	string	Yes	The name of the table. You can call the ListSensitiveColumns operation to obtain the name of the table. Note You can also call the ListTables operation to obtain the name of the table.	test
ColumnName	string	Yes	The name of the field. You can call the ListSensitiveColumns operation to obtain the name of the field. Note You can also call the ListColumns operation to obtain the name of the field.	ColumnName_test
DbId	long	No	The ID of the database. The database can be a physical database or a logical database. To obtain the ID of a physical database, call the ListDatabases or SearchDatabase operation. To obtain the ID of a logical database, call the ListLogicDatabases or SearchDatabase operation.	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
RequestId	string	The ID of the request.	7629888F-C9FB-4D16-A7D3-B443FE06FBD4
SensitiveColumnsDetailList	array<object>	The details of the sensitive field.
SensitiveColumnsDetail	object
DbId	long	The ID of the database.	1860****
ColumnName	string	The name of the field.	ColumnName_test
ColumnDescription	string	The description of the field.	test
TableName	string	The name of the table.	test
DbType	string	The type of the database.	mysql
ColumnType	string	The data type of the field.	varchar(32)
Logic	boolean	Indicates whether the database is a logical database. Valid values: true: The database is a logical database. false: The database is not a logical database.	false
SchemaName	string	The name of the database.	SchemaName_test
SearchName	string	The name that is used to search for the database.	test@xxx:3306
EnvType	string	The type of the environment to which the database belongs.	product
ErrorCode	string	The error code returned.	UnknownError
ErrorMessage	string	The error message returned.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "7629888F-C9FB-4D16-A7D3-B443FE06FBD4",
  "SensitiveColumnsDetailList": {
    "SensitiveColumnsDetail": [
      {
        "DbId": 0,
        "ColumnName": "ColumnName_test",
        "ColumnDescription": "test",
        "TableName": "test",
        "DbType": "mysql",
        "ColumnType": "varchar(32)",
        "Logic": false,
        "SchemaName": "SchemaName_test",
        "SearchName": "test@xxx:3306",
        "EnvType": "product"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "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