DescribeErrorLogs - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the error logs of an instance over a specific time range.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server
MariaDB

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

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5xxxxxxx
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.	2011-05-01T20:10Z
EndTime	string	Yes	The end of the time range to query. The end time must be later than the start time. The time span between the start time and the end time must be less than 31 days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.	2011-05-30T20:10Z
PageSize	integer	No	The number of entries per page. Valid values: 30 to 100. Default value: 30.	30
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
PageNumber	integer	The page number.	1
RequestId	string	The request ID.	98504E07-BB0E-40FC-B152-E4882615812C
PageRecordCount	integer	The number of error logs on the current page.	30
TotalRecordCount	integer	The total number of entries returned.	100
Items	array<object>	Details about the log entries returned.
ErrorLog	object
CreateTime	string	The time when the error log entry was generated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2011-05-30T12:11:04Z
ErrorInfo	string	The error log information.	spid52 DBCC TRACEON 3499, server process ID (SPID) 52. This is an informational message only; no user action is required

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "98504E07-BB0E-40FC-B152-E4882615812C",
  "PageRecordCount": 30,
  "TotalRecordCount": 100,
  "Items": {
    "ErrorLog": [
      {
        "CreateTime": "2011-05-30T12:11:04Z",
        "ErrorInfo": "spid52 DBCC TRACEON 3499, server process ID (SPID) 52. This is an informational message only; no user action is required"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidSearchTimeRange	search time range cannot be longer than a month.	The interval between the end time that is specified by the EndTime parameter and the start time that is specified by the StartTime parameter must be less than 31 days. Check the values of these parameters.
400	IO.Exception	IO exception, retry later.	An I/O error occurred.

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