All Products
Search
Document Center

ApsaraDB RDS:DescribeEventsList

Last Updated:Mar 05, 2026

Queries the events.

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
rdsai:DescribeEventsListget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The operation that you want to perform. Set the value to DescribeEventsList.

cn-beijing
InstanceIdListstringNo

The region ID.

r-uf6ce0r08lr7xnriq2
StartTimestringNo

The RDS Supabase instances.

2025-01-01 18:00:00
EndTimestringNo

The start time of the query period.

2025-08-28 18:00:00
PageSizelongNo

The end time of the query period.

10
PageNumberlongNo

The number of records per page.

1

Response parameters

ParameterTypeDescriptionExample
object

The information about the parameters.

RequestIdstring

The request ID.

FE9C65D7-930F-57A5-A207-8C396329241C
TotalCountlong

The total number of entries returned.

20
TotalPageslong

The number of entries per page.

10
PageCountlong

The total number of pages.

1
PageNumberlong

The page number of the returned page.

1
PageSizelong

The number of entries returned on each page.

10
EventCodeCountsstring

The total number of events.

OtherException:3,MysqlIOException:1
Eventsarray<object>

The information about the events.

Eventsobject

The events.

EventCodestring

The event code.

ExceptionEvent
EventTimeListarray

The event.

EventTimeListstring

The test field.

"2025-08-19T16:04:18Z","2025-08-19T16:04:18Z"
InstanceIdstring

The instance ID.

rm-2zecnb327gp36e7lh
InstanceDescriptionstring

The description of the instance.

RecoveryTimestring

The recovery time.

2025-07-23T02:11:07Z
EventStatusstring

The state of the event.

None

Examples

Sample success responses

JSONformat

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329241C",
  "TotalCount": 20,
  "TotalPages": 10,
  "PageCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "EventCodeCounts": "OtherException:3,MysqlIOException:1",
  "Events": [
    {
      "EventCode": "ExceptionEvent",
      "EventTimeList": [
        "\"2025-08-19T16:04:18Z\",\"2025-08-19T16:04:18Z\""
      ],
      "InstanceId": "rm-2zecnb327gp36e7lh",
      "InstanceDescription": "",
      "RecoveryTime": "2025-07-23T02:11:07Z",
      "EventStatus": "None",
      "RegionId": ""
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IncorrectInstanceStateCurrent instance status does not support this operation.The operation is not supported in the current instance state.
400InvalidGroupNameSpecified group name is not valid.Invalid group name
400InvalidParameterThe provided parameter is invalid.Invalid parameter.
400MasterInstanceNotExistMaster instance does not exist.The primary instance does not exist.
403InsufficientResourceCapacityThere is not enough host resource inventory.Insufficient resources

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

Change history

Change timeSummary of changesOperation
2025-12-23The Error code has changed. The response structure of the API has changedView Change Details
2025-12-03Add OperationView Change Details