ListProxySQLExecAuditLog - Data Management - Alibaba Cloud Documentation Center

Queries the audit logs generated by the secure access proxy feature.

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

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.

Operation	Access level	Resource type	Condition key	Associated operation
dms:ListProxySQLExecAuditLog	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartTime	long	Yes	The beginning of the time range to query. The value of this parameter must be a timestamp that follows the UNIX time format.	1636876446000
EndTime	long	Yes	The end of the time range to query. The value of this parameter must be a timestamp that follows the UNIX time format.	1636962846000
SearchName	string	No	The name of the database instance.	test
OpUserName	string	No	The alias of the user.	testNickName
SQLType	string	No	The type of SQL statement. Valid values: SELECT INSERT DELETE CREATE_TABLE Note You can choose Operation Audit > Secure Access Proxy in the top navigation bar of the DMS console to view more types of SQL statements.	SELECT
ExecState	string	No	The execution status of the SQL statement. Valid values: FAIL: The execution of the SQL statement fails. CANCEL: The execution of the SQL statement is canceled. SUCCESS: The SQL statement is executed.	SUCCESS
PageSize	integer	Yes	The number of entries to return on each page. Maximum values: 100.	100
PageNumber	integer	Yes	The number of the page to return.	1
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.	14****

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The number of entries returned.	1
RequestId	string	The ID of the request.	50ECB006-2C35-5FCA-91B9-01987A0B****
ErrorCode	string	The error code returned.	InvalidStartTime
ErrorMessage	string	The error message returned.	Specified parameter StartTime is not valid.
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ProxySQLExecAuditLogList	array<object>	The audit information about the database instance that is provided by the secure access proxy feature.
ProxySQLExecAuditLog	object
OpTime	string	The time at which the user executes the SQL statement on the database instance. The value of this parameter must be a timestamp that follows the UNIX time format.	1636876446000
UserName	string	The nickname of the user.	testNickName
UserId	long	The ID of the user.	4****
InstanceName	string	The name of the database instance.	pc-uf662nrg017c6****.mysql.polardb.rds.aliyuncs.com:3306【test】
InstanceId	long	The ID of the database instance.	4***
SchemaName	string	The name of the database.	test_db
SQLType	string	The type of the SQL statement. Valid values: SELECT INSERT DELETE CREATE_TABLE Note You can choose Operation Audit > Secure Access Proxy in the top navigation bar of the DMS console to view more types of SQL statements.	SELECT
SQL	string	The SQL statement that was executed.	select 1;
ExecState	string	The execution status of the SQL statement. Valid values: FAIL: The execution of the SQL statement fails. CANCEL: The execution of the SQL statement is canceled. SUCCESS: The SQL statement is executed.	SUCCESS
AffectRows	long	Indicates the total number of rows returned after the SQL statement was executed. If an SELECT SQL statement is executed, the return value of this parameter indicates the total number of the queried data rows.	1
ElapsedTime	long	The amount of time that is consumed to execute the SQL statement. Unit: milliseconds.	1324
Remark	string	The description.	success

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "50ECB006-2C35-5FCA-91B9-01987A0B****",
  "ErrorCode": "InvalidStartTime",
  "ErrorMessage": "Specified parameter StartTime is not valid.",
  "Success": true,
  "ProxySQLExecAuditLogList": {
    "ProxySQLExecAuditLog": [
      {
        "OpTime": "1636876446000",
        "UserName": "testNickName",
        "UserId": 0,
        "InstanceName": "pc-uf662nrg017c6****.mysql.polardb.rds.aliyuncs.com:3306【test】",
        "InstanceId": 0,
        "SchemaName": "test_db",
        "SQLType": "SELECT",
        "SQL": "select 1;",
        "ExecState": "SUCCESS",
        "AffectRows": 1,
        "ElapsedTime": 1324,
        "Remark": "success"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history