DescribeEventsList-阿里云帮助中心

This API retrieves the list of events.

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

rdsai:DescribeEventsList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-beijing
InstanceIdList	string	No	The instance IDs. You can specify one or more instance IDs.	r-uf6ce0r08lr7xn****
StartTime	string	No	The beginning of the time range to query. Specify the time in the YYYY-MM-DD HH:mm:ss format. The time must be in UTC.	2025-01-01 18:00:00
EndTime	string	No	The end of the time range to query. Specify the time in the YYYY-MM-DD HH:mm:ss format. The time must be in UTC.	2025-08-28 18:00:00
PageSize	integer	No	The number of entries to return on each page.	10
PageNumber	integer	No	The number of the page to return.	1

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329****
TotalCount	integer	The total number of entries.	20
TotalPages	integer	The total number of pages.	10
PageCount	integer	The number of pages returned.	1
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
EventCodeCounts	string	The count for each event code.	OtherException:3,MysqlIOException:1
Events	array<object>	A list of events.
	object	An event object.
EventCode	string	The event code.	ExceptionEvent
EventTimeList	array	A list of event times.
	string	The time the event occurred.	"2025-08-19T16:04:18Z","2025-08-19T16:04:18Z"
InstanceId	string	The instance ID.	rm-2zecnb327gp36****
InstanceDescription	string	The instance description.	测试实例
RecoveryTime	string	The recovery time.	2025-07-23T02:11:07Z
EventStatus	string	The event status.	None
RegionId	string	The region ID.

Examples

Success response

JSON format

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****",
  "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-2zecnb327gp36****",
      "InstanceDescription": "测试实例",
      "RecoveryTime": "2025-07-23T02:11:07Z",
      "EventStatus": "None",
      "RegionId": ""
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectInstanceState	Current instance status does not support this operation.	The operation is not supported in the current instance state.
400	InvalidGroupName	Specified group name is not valid.	Invalid group name
400	InvalidParameter	The provided parameter is invalid.	Invalid parameter.
400	MasterInstanceNotExist	Master instance does not exist.	The primary instance does not exist.
403	InsufficientResourceCapacity	There is not enough host resource inventory.	Insufficient resources

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.