Queries the audit logs of sensitive data.

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 ListSensitiveDataAuditLog

The operation that you want to perform. Set the value to ListSensitiveDataAuditLog.

StartTime String Yes 2022-11-18 10:00:00

The beginning of the time range to query. Specify the time in the yyyy-MM-DD HH:mm:ss format.

EndTime String Yes 2022-11-18 11:00:00

The end of the time range to query. Specify the time in the yyyy-MM-DD HH:mm:ss format.

ModuleName String No SQL_CONSOLE

The feature for which you want to query the operation logs. If you do not specify this parameter, the sensitive data logs for all features are returned. Valid values:

  • SQL_CONSOLE: data query
  • SQL_CONSOLE_EXPORT: query result export
  • DATA_CHANGE: data change
  • DATA_EXPORT: data export
OpUserName String No ExampleOpUserName

The name of the user to query.

DbName String No ExampleDbName

The name of the database where sensitive data resides.

TableName String No ExampleTableName

The name of the table where sensitive data resides.

ColumnName String No ExampleColumnName

The name of the column where sensitive data resides.

PageSize Integer Yes 100

The number of entries to return on each page.

PageNumber Integer Yes 1

The number of the page to return.

Tid Long No 3***

The ID of the tenant.

Response parameters

Parameter Type Example Description
RequestId String E0D21075-CD3E-4D98-8264-FD8AD04A63B6

The ID of the request.

TotalCount Long 100

The total number of log data entries.

ErrorCode String 403

The error code returned if the request failed.

ErrorMessage String UnknownError

The error message returned if the request failed.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
SensitiveDataAuditLogList Array of SensitiveDataAuditLogList

The list of audit logs of sensitive data.

UserName String ExampleUserName

The name of the user who performs the operation.

UserId Long 1**

The ID of the user who performs the operation.

ModuleName String SQL_CONSOLE

The name of the feature for which the operation logs were queried.

DbDisplayName String ExampleDbName@xxx.xxx.xxx.xxx:3306

The name of the database where the audit logs of sensitive data were queried.

OpTime String 2022-11-18 10:01:00

The time when the operation was performed. The time is in the yyyy-MM-DD HH:mm:ss format.

InstanceId Long 12****

The ID of the instance.

TargetName String Ticket - 1****

The details of the operation object. The parameter is in the following format:

  • Operation object name - operation object ID
  • Operation object name (operation object ID)
SensitiveDataLog Array of SensitiveDataLog

Sensitive data logs.

TableName String ExampleTableName

The name of the table where sensitive data resides.

ColumnName String ExampleColumnName

The name of the column where sensitive data resides.

SecurityLevel String Low sensitivity

The sensitivity level, which can be divided into three categories:

  • Low sensitivity
  • Medium sensitivity
  • High sensitivity
ColumnPermissionType String Change permission

The user permissions on fields. Valid values:

  • No permission
  • Semi-sensitization permission
  • Plaintext permission
  • Change permission
  • Enable data masking
  • Disable data masking
DesensitizationRule String Default value: Full redaction

The algorithm used for masking.

Examples

Sample requests

 
 
 
 
 
 
 
 
 
 
&Common request parameters

Sample success responses

XML format

 
 

 
     
     
     
     
         
         
         
         
        <TargetName>Ticket - 1****</TargetName>
         
             
             
            <SecurityLevel>Low sensitivity</SecurityLevel>
            <ColumnPermissionType>Change permission</ColumnPermissionType>
            <DesensitizationRule>Default value: Full redaction</DesensitizationRule>
         
     
 

JSON format

 
 

 
   
   
   
   
     
     
     
     
    "TargetName" : "Ticket - 1****",
     
       
       
      "SecurityLevel" : "Low sensitivity",
      "ColumnPermissionType" : "Change permission",
      "DesensitizationRule" : "Default value: Full redaction"
     
   
 

Error codes

For a list of error codes, see Service error codes.