GetOpLog - Data Management - Alibaba Cloud Documentation Center

Queries the details of operation logs that are generated in a specified period of time.

Operation description

Prerequisites: You are an administrator of Data Management (DMS) or a security administrator. You can call the ListUsers or GetUser operation to obtain your user role from the RoleIdList parameter that is returned.

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 query the tenant ID.	3***
Module	string	No	The functional module for which you want to query operation logs. If you do not specify this parameter, operation logs for all functional modules are returned. Valid values: PERMISSION: permissions OWNER: data owner SQL_CONSOLE: data query SQL_CONSOLE_EXPORT: query result export DATA_CHANGE: data change DATA_EXPORT: data export SQL_REVIEW: SQL review DT_SYNC: database and table synchronization DT_DETAIL: database and table details DB_TASK: task management INSTANCE_MANAGE: instance management USER_MANAGE: user management SECURITY_RULE: security rules CONFIG_MANAGE: configuration management RESOURCE_AUTH: resource authorization ACCESS_WHITE_IP: access IP address whitelist NDDL: schema design DSQL_CONSOLE: cross-database data query DSQL_CONSOLE_EXPORT: cross-database query result export DATA_TRACT: data tracking DATA_QUALITY: data quality DATALINK_MANAGE :DBLink management DATASEC_MANAGE: sensitive data management SELL: sales	SECURITY_RULE
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the yyyy-MM-DD HH:mm:ss format.	2022-03-23 10:00:00
EndTime	string	Yes	The end of the time range to query. Specify the time in the yyyy-MM-DD HH:mm:ss format.	2022-03-29 10:00:00
PageSize	integer	Yes	The number of entries to return on each page. Valid values: 30 50 100	30
PageNumber	integer	Yes	The number of the page to return. Pages start from page 1.	1
UserNick	string	No	UserNick.	test_name
DatabaseName	string	No	DatabaseName.	dmstest@rm-bp1qb97d4b****.mysql.rds.aliyuncs.com:3306[poc_dev]

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of operation logs that are returned.	1
RequestId	string	The ID of the request.	47D56208-DB1D-4FD3-BE32-300E43185488
ErrorCode	string	The error code.	403
OpLogDetails	array<object>	The details of the operation log.
OpLogDetail	object	The details of the operation log.
Module	string	The functional module for which the operation log is queried.	SECURITY_RULE
Database	string	The endpoint of the database instance. Note This parameter is valid only for database instances of the LocalInstance type. This parameter is valid only for operations on the functional modules related to tasks.	dmstest_prod_database@dmstest.rds... \[Test instance]
UserId	string	The ID of the Alibaba Cloud account.	22275482072787****
OpUserId	long	The ID of the user who performed the operation.	51****
OpContent	string	The details of the operation.	SELECT * FROM `orders` \n LIMIT 20
UserNick	string	The display name of the user.	test_name
OrderId	long	The ID of the ticket or task. Note This parameter is valid only for operations on the functional modules related to tasks and the task management module in system management.	509****
OpTime	string	The time when the operation was performed.	2022-03-28 16:45:19
ErrorMessage	string	The error message returned if the request failed.	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

{
  "TotalCount": 1,
  "RequestId": "47D56208-DB1D-4FD3-BE32-300E43185488",
  "ErrorCode": "403",
  "OpLogDetails": {
    "OpLogDetail": [
      {
        "Module": "SECURITY_RULE\n",
        "Database": "dmstest_prod_database@dmstest.rds... \\[Test instance]\n",
        "UserId": "22275482072787****",
        "OpUserId": 0,
        "OpContent": "SELECT * FROM `orders` \\n LIMIT 20",
        "UserNick": "test_name",
        "OrderId": 0,
        "OpTime": "2022-03-28 16:45:19"
      }
    ]
  },
  "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
2023-04-27	The request parameters of the API has changed	View Change Details
2023-04-27	The request parameters of the API has changed	View Change Details

SDK sample code

For more information about how to call this operation by using an SDK, see Alibaba Cloud SDK for Python.

Sample code:

from aliyunsdkcore.client import AcsClient
from aliyunsdkdms_enterprise.request.v20181101.GetOpLogRequest import GetOpLogRequest
client = AcsClient(
    "<your-access-key-id>",
   "<your-access-key-secret>",
   "<your-region-id>"
)
request = GetOpLogRequest()
request.set_Tid("The tenant ID of your enterprise")
request.set_StartTime("2018-11-20 00:00:00")
request.set_EndTime("2018-11-23 00:00:00")
request.set_PageNumber(1)
request.set_PageSize(50)
response = client.do_action_with_exception(request)
print response