Call ListInstanceLoginAuditLog to query instance logon records - Data Management - Alibaba Cloud - Data Management

Queries the login audit logs of an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListInstanceLoginAuditLog

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The beginning of the time range to query. Note Fuzzy match is supported. Format: YYYY-MM-DD hh:mm:ss.	2021-11-18 11:00:00
EndTime	string	Yes	The end of the time range to query. Note Fuzzy match is supported. Format: YYYY-MM-DD hh:mm:ss. We recommend that you specify a time range of no more than one day to improve pagination efficiency.	2021-11-18 18:00:00
SearchName	string	No	The name of the database or instance whose login audit logs you want to query. Note Set this parameter to an instance name if SQL statements are executed at the instance level, or a database name if at the database level.	test_SearchName
OpUserName	string	No	The alias of the user.	test_OpUserName
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100.	20
PageNumber	integer	No	The number of the page to return.	1
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.	3***

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The number of entries returned.	1
RequestId	string	The ID of the request.	074CE7C9-4F9C-5B62-89BC-7B4914A3****
ErrorCode	string	The error code returned.	InvalidPageSize
ErrorMessage	string	The error message returned.	Specified parameter PageSize is not valid.
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
InstanceLoginAuditLogList	object
InstanceLoginAuditLog	array<object>	The login audit logs of the instance.
	object
OpTime	string	The time when the user performed an operation on the instance.	2021-11-18 11:13:26
UserName	string	The alias of the user.	test_UserName
UserId	integer	The ID of the user.	12****
InstanceName	string	The name of the instance.	rm-bp144d5ky4l4rli0417**.mysql.rds.aliyuncs.com:3306【rm-bp144d5ky4l4r**】
InstanceId	integer	The ID of the instance.	177****
DbUser	string	The database account used to log in to the instance.	test_User
RequestIp	string	The source IP address of the request.	117.36.XX.XX,100.104.XX.XX

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "074CE7C9-4F9C-5B62-89BC-7B4914A3****",
  "ErrorCode": "InvalidPageSize",
  "ErrorMessage": "Specified parameter PageSize is not valid.",
  "Success": true,
  "InstanceLoginAuditLogList": {
    "InstanceLoginAuditLog": [
      {
        "OpTime": "2021-11-18 11:13:26",
        "UserName": "test_UserName",
        "UserId": 0,
        "InstanceName": "rm-bp144d5ky4l4rli0417****.mysql.rds.aliyuncs.com:3306【rm-bp144d5ky4l4r****】",
        "InstanceId": 0,
        "DbUser": "test_User",
        "RequestIp": "117.36.XX.XX,100.104.XX.XX"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.