All Products
Search

This Product

    ApsaraDB RDS:DescribeSQLLogFiles

    Document Center

    ApsaraDB RDS:DescribeSQLLogFiles

    Last Updated:Jul 26, 2024

    Queries the log files that are generated by the SQL Explorer (SQL Audit) feature for an instance. The DescribeSQLLogFiles operation does not return the log files that are generated by the SQL Explorer feature and manually exported from the ApsaraDB RDS console. The DescribeSQLLogFiles operation returns the SQL Explorer log files that are generated by calling the DescribeSQLLogRecords operation with the request parameter Form set to File.

    Operation description

    Supported database engines

    • MySQL

    • PostgreSQL

    • SQL Server

      **

      Note If your instance runs SQL Server, only SQL Server 2008 R2 is supported.

    Precautions

    • The DescribeSQLLogFiles operation does not return the log files that are generated by SQL Explorer Trial Edition for an ApsaraDB RDS for MySQL instance.

    • The DescribeSQLLogFiles operation does not return the log files that are generated by the SQL Explorer feature and manually exported from the ApsaraDB RDS console. The DescribeSQLLogFiles operation returns the SQL Explorer log files that are generated by calling the DescribeSQLLogRecords operation with the request parameter Form set to File.

    • The exported files are retained for only two days.

      **

      Note If you have enabled Database Autonomy Service (DAS) Enterprise Edition V2 or V3 and have enabled the SQL Explorer and Audit feature, the exported files are retained for seven days. You can call the DescribeSqlLogConfig operation to query the information about the enabled DAS Enterprise Edition.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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
    rds:DescribeSQLLogFilesget
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

    		rm-uf6wjk5xxxxxx
    FileNamestringNo

    The name of the audit log file.

    		custinsxxxxx.csv
    PageSizeintegerNo

    The number of entries to return on each page. Valid value: 30 to 200. Default value: 30.

    		30
    PageNumberintegerNo

    The number of the page to return. Valid values: 1 to 100000. Default value: 1.

    		1

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		 1AD222E9-E606-4A42-BF6D-8A4442913CEF
    PageNumberinteger

    The page number of the returned page.

    		1
    PageRecordCountinteger

    The number of entries returned per page.

    		10
    TotalRecordCountinteger

    The total number of entries returned.

    		10
    Itemsarray<object>

    An array that consists of the returned audit log files.

    object
    FileIDstring

    The file name.

    		custinsxxxxx.csv
    LogStartTimestring

    The time at which the first SQL statement recorded in the audit log file was executed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		2015-05-23T07:00:00Z
    LogSizestring

    The size of the audit log file. Unit: bytes.

    		3000
    LogDownloadURLstring

    The download URL of the file. If the audit log file cannot be downloaded, this parameter is null.

    		http://rdslog-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx
    LogEndTimestring

    The time at which the last SQL statement recorded in the audit log file was executed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		2015-05-24T07:00:00Z
    LogStatusstring

    The status of the audit log file. Valid values:

    • Success
    • Failed
    • Generating
    		Success

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": " 1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": 1,
  "PageRecordCount": 10,
  "TotalRecordCount": 10,
  "Items": {
    "LogFile": [
      {
        "FileID": "custinsxxxxx.csv",
        "LogStartTime": "2015-05-23T07:00:00Z",
        "LogSize": "3000",
        "LogDownloadURL": "http://rdslog-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
        "LogEndTime": "2015-05-24T07:00:00Z",
        "LogStatus": "Success"
      }
    ]
  }
}

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
    400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
    400Order.NoRealNameAuthenticationYou 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 user center for real-name authentication.
    400InsufficientAvailableQuotaYour 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.
    400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
    400RegionDissolvedEOMDear 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.
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
    400Price.CommoditySysCommodity system call exception.Commodity system call exception.
    400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
    400pay.noCreditCardAccount not bound to credit card.-
    400Order.InstHasUnpaidOrderThere 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.
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
    400Api.NotSupportSpecified api is not supported.The current interface does not support.
    400ContainForbiddenLabelErrorThere 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.
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
    400InvalidParamSepcified 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.
    400KmsApiErrorUser secret key invalid.The user key is invalid.
    400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
    400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
    400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
    400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.The current instance engine version not support coldDataEnabled.
    400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.The current instance minor version not support coldDataEnabled.
    400IncorrectTargetClasscodeThe current instance type does not support this operation.This operation is not supported by the instance type.
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.The link address name is duplicate. Please reset the connection string.
    400RequiredParam.NotFoundRequired input param is not found.-
    400Parameters.InvalidParameter error, please check the parameters.Parameter error, please check the parameters.
    400BackupPolicyNotSupportCold 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.
    400InvalideStatus.FormatThe instance status does not support this operation.-
    400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.Specified Released Keep Policy is not valid.
    400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
    400Pay.NoCreditCardNo credit cards.No credit cards.
    400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.The vpc network type instance does not support this operation.
    400MirrorInsExistsSpecified DB instance mirror ins already existed.Specified DB instance mirror ins already existed.
    400UnsupportedClassCodeThe specified DB instance class stops selling.The specified DB instance class stops selling.
    400InvalidBackupSetThe specified database does not exist in the backup set.The specified database does not exist in the backup set.
    400OrdTCommodityQueryErrorFailed to query for product.Failed to query product.
    403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
    403InvalidReduceDiskSizeThe 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
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
    403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
    403InvalidVswitchIdSpecified conn vswitch id is not valid.-
    403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
    403OperationDenied.ZoneResourceThere is no available zone for inventory.There is no available zone for inventory.
    403NotInFlowControllerSorry,no permission.Sorry,no permission.
    403InvalidKmsKeyKms key is disabled.-
    403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.The specified database instance type does not support this operation.
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
    404Request.NotFoundThe requested resource is not available.The requested resources are unavailable.
    404HostInfo.NotFoundThe specified host info is not found.-
    500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.
    500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.The service request failed. Please try again later or contact service personnel.
    500InvokeProxyFailureThe request processing has failed due to service failure of rds api.The request failed to be processed due to an RDS API failure.
    504OperationDenied.TimeoutThe request processing has failed due to timeout.Request failed due to timeout processing

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

    Change history

    Change timeSummary of changesOperation
    2024-07-11The Error code has changedView Change Details
    2024-05-11The Error code has changedView Change Details