All Products
Search
Document Center

Data Management:ListSensitiveDataAuditLog

Last Updated:Nov 28, 2024

Queries the audit logs for sensitive information.

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:ListSensitiveDataAuditLoglist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimestringYes

The beginning of the time range for which you want to query the audit logs for sensitive information. Specify the time in the yyyy-MM-DD HH:mm:ss format.

2022-11-18 10:00:00
EndTimestringYes

The end of the time range for which you want to query the audit logs for sensitive information. Specify the time in the yyyy-MM-DD HH:mm:ss format.

2022-11-18 11:00:00
ModuleNamestringNo

The function module whose audit logs you want to query for sensitive data. If you do not specify this parameter, all audit logs are queried. Valid values:

  • SQL_CONSOLE: data query
  • SQL_CONSOLE_EXPORT: query result export
  • DATA_CHANGE: data change
  • DATA_EXPORT: data export
SQL_CONSOLE
OpUserNamestringNo

The username of the requester.

ExampleOpUserName
DbNamestringNo

The name of the database that stores the sensitive data.

ExampleDbName
TableNamestringNo

The name of the table that stores the sensitive data.

ExampleTableName
ColumnNamestringNo

The name of the column that contains sensitive data.

ExampleColumnName
PageSizeintegerYes

The number of entries to return on each page. Example: 100

100
PageNumberintegerYes

The number of the page to return.

1
TidlongNo

The ID of the tenant.

3***

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

E0D21075-CD3E-4D98-8264-FD8AD04A63B6
TotalCountlong

The total number of entries returned.

100
ErrorCodestring

The error code returned if the request failed.

403
ErrorMessagestring

The error message returned if the request failed.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
SensitiveDataAuditLogListarray<object>

The audit logs for sensitive data.

SensitiveDataAuditLogListobject
UserNamestring

The username of the requester.

ExampleUserName
UserIdlong

The user ID of the requester.

1**
ModuleNamestring

The name of the function module whose audit logs were queried.

SQL_CONSOLE
DbDisplayNamestring

The name of the database that stores the sensitive data.

ExampleDbName@xxx.xxx.xxx.xxx:3306
OpTimestring

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

2022-11-18 10:01:00
InstanceIdlong

The ID of the instance.

12****
TargetNamestring

The details of the object on which the operation was performed. The value of this parameter is in one of the following formats:

  • Object name - object ID
  • Object name (object ID)
Ticket - 1\*\*\*\*
SensitiveDataLogarray<object>

The logs for sensitive data.

SensitiveDataLogobject
TableNamestring

The name of the table that stores the sensitive data.

ExampleTableName
ColumnNamestring

The name of the column that contains sensitive data.

ExampleColumnName
SecurityLevelstring

The sensitivity level of the data. Valid values:

  • Low
  • Medium
  • High
Low
ColumnPermissionTypestring

The permission that the user has on the column. Valid values:

  • No permission
  • Partial redaction
  • Plaintext
  • Change
  • Enable data masking
  • Disable data masking
Change
DesensitizationRulestring

The algorithm used for data masking.

Default - Full redaction

Examples

Sample success responses

JSONformat

{
  "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "TotalCount": 100,
  "ErrorCode": "403",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "SensitiveDataAuditLogList": [
    {
      "UserName": "ExampleUserName",
      "UserId": 0,
      "ModuleName": "SQL_CONSOLE",
      "DbDisplayName": "ExampleDbName@xxx.xxx.xxx.xxx:3306",
      "OpTime": "2022-11-18 10:01:00",
      "InstanceId": 0,
      "TargetName": "Ticket - 1\\*\\*\\*\\*\n",
      "SensitiveDataLog": [
        {
          "TableName": "ExampleTableName",
          "ColumnName": "ExampleColumnName",
          "SecurityLevel": "Low\n",
          "ColumnPermissionType": "Change\n",
          "DesensitizationRule": "Default - Full redaction\n"
        }
      ]
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history