DescribeEvents - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribeEvents operation to query the historical events of an ApsaraDB RDS instance.

Operation Description

The name of the event. For more information, see View the event history of an ApsaraDB RDS instance.

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:DescribeEvents	READ	RDS acs:rds::{#accountId}:dbinstance/ RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The details of the events.	cn-hangzhou
StartTime	string	No	The name of the resource associated with the event. Only instance IDs are supported for this parameter.	2019-06-11T15:00:00Z
EndTime	string	No	The ID of the event.	2019-06-12T15:00:00Z
PageSize	integer	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	30
PageNumber	integer	No	The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	1

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The operation that you want to perform. Set the value to DescribeEvents.	1
RequestId	string	The region ID of the instance.	A103039D-B1B2-4C57-B989-7D7C0DA95426
PageSize	integer	The number of the page to return. Valid values: any non-zero positive integer. Default value: 1.	30
TotalRecordCount	integer	The total number of entries returned.	40
EventItems	object []	The region ID of the instance. You can call the DescribeRegions operation to query the IDs of regions.
EventName	string	The ID of the user who executed the event.	ModifySecurityIPList
EventTime	string	The source of the event. For more information, see View the event history of an ApsaraDB RDS instance.	2019-08-20T01:08:22Z
EventUserType	string	The number of entries to return on each page. Valid values: 30 50 100 Default value: 30.	SYSTEM
EventRecordTime	string	The page number of the returned page.	2019-08-20T01:12:49Z
CallerUid	long	The number of entries returned per page.	22973492**********
RegionId	string	The type of the user who executed the event.	cn-hangzhou
EventId	integer	The type of the event. For more information, see View the event history of an ApsaraDB RDS instance.	11000053
EventType	string	The type of the resource associated with the event. Only instances are supported for this parameter.	NetworkManagement
ResourceType	string	The time when the event was recorded. The time is slightly later than the time the event occurred.	instance
EventPayload	string	The ID of the request.	{\"Domain\": \"rds-inc-share.aliyuncs.com\", \"Api\": \"ReleaseInstancePublicConnection\"}

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "A103039D-B1B2-4C57-B989-7D7C0DA95426",
  "PageSize": 30,
  "TotalRecordCount": 40,
  "EventItems": {
    "EventItems": [
      {
        "EventName": "ModifySecurityIPList",
        "EventTime": "2019-08-20T01:08:22Z",
        "EventUserType": "SYSTEM",
        "EventRecordTime": "2019-08-20T01:12:49Z",
        "CallerUid": 0,
        "RegionId": "cn-hangzhou",
        "EventId": 11000053,
        "EventType": "NetworkManagement",
        "ResourceType": "instance",
        "EventPayload": "{\\\"Domain\\\": \\\"rds-inc-share.aliyuncs.com\\\", \\\"Api\\\": \\\"ReleaseInstancePublicConnection\\\"}",
        "EventReason": "FROM_USER",
        "ResourceName": "rm-bp1z3065m9976ix8a"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Format	Specified start time is not valid.	The start time is invalid.
400	InvalidParameterCombination	The end time must be greater than the start time	The end time must be later than the start time.
400	RegionNotSupport	The region is not supported.	The operation failed. The operation is not supported in the region.
404	InvalidRegion.NotFound	Specified Region does not exist in the RDS	The region ID is invalid.

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

Change history

Change time

Summary of changes

Operation

2022-10-28

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 404 change
	delete Error Codes: 400