All Products
Search

This Product

    ENS:DescribeHistoryEvents

    Document Center

    ENS:DescribeHistoryEvents

    Last Updated:Mar 27, 2026

    Retrieves a list of system events.

    Operation description

    • The required EventTypes parameter allows you to specify one or more event types in a single request.

    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

    ens:DescribeHistoryEvents

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PageNumber

    integer

    No

    The page number.

    1
    PageSize

    integer

    No

    The number of entries per page.

    10
    EventTypes

    array

    Yes

    The event types.

    string

    No

    The event type. Valid values:

    • Instance:SystemFailure.Redeploy: The instance is redeployed due to a system failure.

    • Instance:SystemFailure.Reboot: The instance is restarted due to a system error.

    • Instance:RegionNetworkDown: A network interruption occurred on the node.

    • Disk:Stalled: The disk performance is degraded.

    • EnsRegion:NetworkMigration: The instance is migrated due to a system error.

    • IP:SafeRisk: An IP address alert is triggered.

    • IP:SafeBan: The IP address is blocked.

    • Instance:SystemUpgrade.Migrate: The instance is migrated due to an underlying system upgrade.

    • Instance:SystemMaintenance.Redeploy: The instance is redeployed for system maintenance.

    Instance:SystemFailure.Reboot
    EventLevels

    array

    No

    The event levels.

    string

    No

    The event level. Valid values:

    • CRITICAL: critical.

    • WARN: warning.

    • INFO: informational.

    WARN
    ResourceIds

    array

    No

    The resource IDs.

    string

    No

    The resource ID.

    i-55qi8m11rr53c4i964md8a00l
    EventStatus

    array

    No

    The event statuses.

    string

    No

    The event status. Valid values:

    • Inquiring: The event is being investigated.

    • Scheduled: The event is scheduled.

    • Executing: The event is in progress.

    • Executed: The event is complete.

    • Failed: The event has failed.

    • Canceled: The event is canceled.

    • Avoided: The event was averted.

    Inquiring

    Response elements

    Element

    Type

    Description

    Example

    object

    The response object.

    RequestId

    string

    The request ID.

    5359599C-F656-57BD-8A0D-329A2FD511A6
    Events

    array<object>

    The list of events.

    object

    The details of an event.

    EventId

    string

    The event ID.

    e-d71ff150945b9c02eb6ebc0016328468
    EventStatus

    string

    The event status. Valid values:

    • Inquiring: The event is under inquiry.

    • Scheduled: The event is scheduled.

    • Executing: The event is in progress.

    • Executed: The event has been executed.

    • Failed: The event has failed.

    • Canceled: The event is canceled.

    • Avoided: The event is avoided.

    Inquiring
    EventType

    string

    The event type. Valid values:

    • Instance:SystemFailure.Redeploy: The instance is redeployed due to a system issue.

    • Instance:SystemFailure.Reboot: The instance is rebooted due to a system error.

    • Instance:RegionNetworkDown: The node is experiencing a network interruption.

    • Disk:Stalled: The disk performance is degraded.

    • EnsRegion:NetworkMigration: The instance is migrated due to a system error.

    • IP:SafeRisk: An IP alert is triggered.

    • IP:SafeBan: The IP address is blocked.

    • Instance:SystemUpgrade.Migrate: The instance must be migrated for an underlying system upgrade.

    • Instance:SystemMaintenance.Redeploy: The instance is redeployed for system maintenance.

    Instance:SystemFailure.Reboot
    ResourceId

    string

    The ID of the associated resource.

    i-55qi8m11rr53c4i964md8a00l
    EventLevel

    string

    The event level. Valid values:

    • CRITICAL: A critical event that requires immediate attention.

    • WARN: A warning that may indicate a potential issue.

    • INFO: An informational message that does not require action.

    WARN
    PublishTime

    integer

    The time the event was published, represented as a Unix timestamp in milliseconds.

    1715578245000
    ExtendedAttribute

    string

    The extended attributes of the event, in JSON format.

    {}
    Reason

    string

    The reason for the event.

    System policy quota is insufficient
    NotBefore

    integer

    The scheduled execution time for the event, represented as a Unix timestamp in milliseconds.

    1715578245000
    PublishUtcTime

    string

    The time the event was published, in UTC format.

    NotBeforeUtcTime

    string

    The scheduled execution time, in UTC format.

    PageNumber

    integer

    The number of the page to return.

    1
    PageSize

    integer

    The number of entries per page.

    10
    TotalCount

    integer

    The total number of entries that match the query.

    30

    Examples

    Success response

    JSON format

    {
  "RequestId": "5359599C-F656-57BD-8A0D-329A2FD511A6",
  "Events": [
    {
      "EventId": "e-d71ff150945b9c02eb6ebc0016328468",
      "EventStatus": "Inquiring",
      "EventType": "Instance:SystemFailure.Reboot",
      "ResourceId": "i-55qi8m11rr53c4i964md8a00l",
      "EventLevel": "WARN",
      "PublishTime": 1715578245000,
      "ExtendedAttribute": "{}",
      "Reason": "System policy quota is insufficient",
      "NotBefore": 1715578245000,
      "PublishUtcTime": "",
      "NotBeforeUtcTime": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 30
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 NoPermission Permission denied.
    400 InvalidParameter.%s The specified field %s invalid. Please check it again.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.