Use DescribeSQLLogRecords to query SQL audit logs - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

Queries the SQL Explorer (SQL Audit) logs of an ApsaraDB RDS instance. This API operation is deprecated and no longer maintained, but can still be called.

Operation description

This API operation has reached End of maintenance. Normal invocation is still supported, but Alibaba Cloud no longer provides maintenance for it. Invoke the GetDasSQLLogHotData API operation instead.

Precautions

Each user (including the Alibaba Cloud account and Resource Access Management (RAM) users) can invoke this API operation up to 1,000 times per minute, regardless of whether the invocation succeeded or failed.
This API operation does not support querying SQL Explorer logs for the SQL Explorer trial edition of ApsaraDB RDS for MySQL instances.
When this API operation generates an audit file (the Form request parameter is set to File), it records up to 1 million log entries and does not support filtering logs by keyword.

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

rds:DescribeSQLLogRecords

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. You can generate the value of this parameter on the client side. The value must be unique across different requests and can contain a maximum of 64 ASCII characters. The value cannot contain non-ASCII characters.	ETnLKlblzczshOTUbOCz****
DBInstanceId	string	Yes	The ID of the instance. You can call the DescribeDBInstances operation to obtain the instance ID.	rm-uf6wjk5****
SQLId	integer	No	The reserved parameter.	None
QueryKeywords	string	No	The keywords used for the query. When an audit file is generated by calling the API operation (the Form request parameter is set to File), filtering by keyword is not supported. Separate multiple keywords with spaces. You can specify up to 10 keywords. The logical relationship between keywords is AND. If a field name in the SQL statement is enclosed in backticks (`), you must also include the backticks when using the field name as a query keyword. For example, if the field name is `id`, enter `id` instead of id. Note After you enter keywords, the system matches the keywords based on the Database, User, and QueryKeywords parameters at the same time. The logical relationship among these three request parameters is AND.	table_name
StartTime	string	Yes	The start time of the query. You can query data generated within the last 7 days. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note If DAS Enterprise Edition V3 is activated and its SQL Explorer and Audit feature is used, you can query data within the hot storage duration. You can call the DescribeSqlLogConfig operation to query the activation information of the Enterprise Edition.	2011-06-01T15:00:00Z
Database	string	No	The name of the database. By default, all databases are queried. You can also enter a database name to query a specific database. You can enter only one database name at a time.	Database
User	string	No	The name of the user. By default, all users are queried. You can also enter a username to query a specific user. You can enter only one username at a time.	user
Form	string	No	Specifies whether to trigger the generation of an audit file or return a list of SQL records. Valid values: File: triggers the generation of an audit file and returns only common parameters. You must call the DescribeSQLLogFiles operation to obtain the final download URL of the file. Stream: returns a list of SQL records. This is the default value. Note If this parameter is set to File, only ApsaraDB RDS for MySQL instances with premium local SSDs and ApsaraDB RDS for SQL Server instances are supported, and up to 1 million log entries can be recorded.	Stream
EndTime	string	Yes	The end time of the query. The end time must be later than the start time, and the interval between the start time and the end time must be less than or equal to 7 days. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note If DAS Enterprise Edition V3 is activated and its SQL Explorer and Audit feature is used, you can query data within the hot storage duration. You can call the DescribeSqlLogConfig operation to query the activation information of the Enterprise Edition.	2011-06-06T15:00:00Z
PageSize	integer	No	The number of entries per page. Valid values: 30 to 100. Default value: 30.	30
PageNumber	integer	No	The page number. Valid values: any integer greater than 0 and less than or equal to the maximum value of the Integer type. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	The details of the response parameters.
Items	object
SQLRecord	array<object>	The list of SQL audit logs.
	object	The details of the SQL audit log.
AccountName	string	The name of the account that performed the operation.	accounttest
DBName	string	The name of the database.	testDB
ExecuteTime	string	The execution time. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format in UTC.	2011-06-11T15:00:23Z
HostAddress	string	The IP address of the client that connected to the database.	192.168.XX.XX
ReturnRowCounts	integer	The number of returned records.	30
SQLText	string	The SQL statement.	update test.zxb set id=0 limit 1
ThreadID	string	The thread ID.	1025865428
TotalExecutionTimes	integer	The execution duration. Unit: microseconds.	600
PageNumber	integer	The page number.	1
PageRecordCount	integer	The number of SQL audit logs on the current page.	30
RequestId	string	The request ID.	08A3B71B-FE08-4B03-974F-CC7EA6DB1828
TotalRecordCount	integer	The total number of records.	100

Examples

Success response

JSON format

{
  "Items": {
    "SQLRecord": [
      {
        "AccountName": "accounttest",
        "DBName": "testDB",
        "ExecuteTime": "2011-06-11T15:00:23Z",
        "HostAddress": "192.168.XX.XX",
        "ReturnRowCounts": 30,
        "SQLText": "update test.zxb set id=0 limit 1",
        "ThreadID": "1025865428",
        "TotalExecutionTimes": 600
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 30,
  "RequestId": "08A3B71B-FE08-4B03-974F-CC7EA6DB1828",
  "TotalRecordCount": 100
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidQueryTimeRange	The query time range is invalid.	Invalid query time range
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	The account is not bound to a credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	No payment method has been specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.	The required parameters are not provided.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.	The current instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed to be processed due to an RDS API failure.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	This operation is not supported for standard SSDs. Upgrade to ESSDs.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	The specified VSwitchId is invalid or empty.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.	The specified KMS key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.	The specified host information does not exist.
408	OperationDenied.Timeout	The request processing has failed due to timeout.	Request failed due to timeout processing

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.