Retrieves action events that match specified criteria, supporting pagination and sorting.
Try it now
Test
RAM authorization
Request syntax
POST /api/v1/instances/listOperationEvents HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| body |
object |
No |
The request body. |
|
| pageSize |
integer |
No |
The page size. Default value: 50. Maximum value: 100. |
30 |
| pageNumber |
integer |
No |
The page number. Default value: 1. |
1 |
| state |
string |
No |
Filters events by state. |
success |
| eventName |
string |
No |
Filters events by name. |
COLD_UPGRADE |
| eventType |
string |
No |
Filters events by type. |
SYSTEM_MAINTENANCE |
| scheduleTimeDesc |
boolean |
No |
Specifies whether to sort events by schedule time in descending order. |
true |
| eventNameDesc |
boolean |
No |
Specifies whether to sort events by event name in descending order. |
true |
| instanceId |
string |
No |
The instance ID. |
hgpost-cn-xxx |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Response schema |
||
| RequestId |
string |
The request ID. |
D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70 |
| Data |
array<object> |
The event list. |
|
|
array<object> |
An event object. |
||
| Id |
string |
The event ID. |
1826503661244379138 |
| Cancelable |
boolean |
Specifies whether the event can be canceled. |
true |
| ChangeScheduleTime |
boolean |
Specifies whether the scheduled time for the event can be changed. |
true |
| ScheduleTime |
string |
The scheduled time of the event. |
2024-08-22 15:49:28 |
| State |
string |
The state of the event. |
queued |
| ResourceId |
string |
The resource ID. |
hgpost-cn-sxfsdfsd |
| EventType |
string |
The event type. |
UPGRADE_ON_CUSTOMERS_BEHALF |
| EventName |
string |
The event name. |
HOT_UPGRADE |
| InstanceName |
string |
The instance name. |
haha |
| ZoneId |
string |
The zone ID. |
cn-hangzhou-k |
| MaintainWindow |
string |
The maintenance window. |
21:00-22:00 |
| FollowerInstances |
array<object> |
The follower instance list. |
|
|
object |
A follower instance object. |
||
| InstanceId |
string |
The instance ID. |
hgxxxx |
| InstanceName |
string |
The instance name. |
hi |
| Detail |
string |
The event details. |
{} |
| PageSize |
integer |
The number of entries to return on each page. Default value: 50. Maximum value: 100. |
30 |
| PageNumber |
integer |
The page number to return. Default value: 1. |
3 |
| TotalCount |
integer |
The total number of entries that match the query. |
120 |
Examples
Success response
JSON format
{
"RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
"Data": [
{
"Id": "1826503661244379138",
"Cancelable": true,
"ChangeScheduleTime": true,
"ScheduleTime": "2024-08-22 15:49:28",
"State": "queued",
"ResourceId": "hgpost-cn-sxfsdfsd",
"EventType": "UPGRADE_ON_CUSTOMERS_BEHALF",
"EventName": "HOT_UPGRADE",
"InstanceName": "haha",
"ZoneId": "cn-hangzhou-k",
"MaintainWindow": "21:00-22:00",
"FollowerInstances": [
{
"InstanceId": "hgxxxx",
"InstanceName": "hi"
}
],
"Detail": "{}"
}
],
"PageSize": 30,
"PageNumber": 3,
"TotalCount": 120
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.