Queries the system events of an instance. By default, system events that are in the Executed, Avoided, Canceled, or Failed state are queried. You can specify the InstanceEventCycleStatus parameter to query system events in other states.

Description

  • You can query finished system events within the last 30 days. The time range for querying unfinished system events is unlimited.
  • You can also specify the InstanceEventCycleStatus parameter to query system events that are in the Scheduled, Executing, or Inquiring state.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstanceHistoryEvents

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

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

InstanceId String No i-uf678mass4zvr9n1****

The ID of the resource. Valid values:

  • When the ResourceType parameter is set to instance, the InstanceId parameter specifies the ID of the ECS instance.
  • When the ResourceType parameter is set to ddh, the InstanceId parameter specifies the ID of the dedicated host.
  • When the ResourceType parameter is set to managedhost, the InstanceId parameter specifies the ID of the physical machine in the smart hosting pool (SHP).

If this parameter is not specified, the system events of all resources of the resource type specified by ResourceType within the region specified byRegionId are queried.

Note We recommend that you use the ResourceId.N parameter to specify one or more resource IDs. If you specify both the ResourceId.N parameter and the InstanceId parameter, the ResourceId.N parameter takes precedence.
EventCycleStatus String No Executed

The lifecycle status of the system event. This parameter takes effect only when the InstanceEventCycleStatus.N parameter is not specified. Valid values:

  • Scheduled
  • Avoided
  • Executing
  • Executed
  • Canceled
  • Failed
  • Inquiring
EventType String No SystemMaintenance.Reboot

The event type of the system event. This parameter takes effect only when the InstanceEventType.N parameter is not specified. Valid values:

  • SystemMaintenance.Reboot: The instance is restarted due to system maintenance.
  • SystemMaintenance.Redeploy: The instance is redeployed due to system maintenance.
  • SystemFailure.Reboot: The instance is restarted due to a system failure.
  • SystemFailure.Redeploy: The instance is redeployed due to a system failure.
  • SystemFailure.Delete: The instance is released due to an instance creation failure.
  • InstanceFailure.Reboot: The instance is restarted due to an instance failure.
  • InstanceExpiration.Stop: The instance is stopped due to subscription expiration.
  • InstanceExpiration.Delete: The instance is released due to subscription expiration.
  • AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to overdue payments.
  • AccountUnbalanced.Delete: The pay-as-you-go instance is released due to overdue payments.
NotBefore.Start String No 2017-11-30T06:32:31Z

The start time of the scheduled event execution period. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

NotBefore.End String No 2017-12-01T06:32:31Z

The end time of the scheduled event execution period. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

EventPublishTime.Start String No 2017-11-30T06:32:31Z

The start time of the period during which the system event is published. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

EventPublishTime.End String No 2017-12-01T06:32:31Z

The end time of the period during which the system event is published. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1.

Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 100.

Default value: 10.

ResourceType String No instance

The type of the resource. Valid values:

  • instance: ECS instance
  • ddh: dedicated host
  • managehost: physical machine in an SHP

Default value: instance.

EventId.N String No e-uf64yvznlao4jl2c****

The ID of system event N. Valid values of N: 1 to 100. Specify multiple event IDs in the form of a repeated list.

InstanceEventCycleStatus.N String No Executed

The lifecycle status of system event N. Valid values of N: 1 to 6. Specify multiple values in the form of a repeated list. Valid values:

  • Scheduled
  • Avoided
  • Executing
  • Executed
  • Canceled
  • Failed
  • Inquiring
InstanceEventType.N String No SystemMaintenance.Reboot

The event type of system event N. Valid values of N: 1 to 30. Specify multiple values in the form of a repeated list. Valid values:

  • SystemMaintenance.Reboot: The instance is restarted due to system maintenance.
  • SystemMaintenance.Redeploy: The instance is redeployed due to system maintenance.
  • SystemFailure.Reboot: The instance is restarted due to a system failure.
  • SystemFailure.Redeploy: The instance is redeployed due to a system failure.
  • SystemFailure.Delete: The instance is released due to an instance creation failure.
  • InstanceFailure.Reboot: The instance is restarted due to an instance failure.
  • InstanceExpiration.Stop: The instance is stopped due to subscription expiration.
  • InstanceExpiration.Delete: The instance is released due to subscription expiration.
  • AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to overdue payments.
  • AccountUnbalanced.Delete: The pay-as-you-go instance is released due to overdue payments.
ResourceId.N String No i-uf678mass4zvr9n1****

The ID of resource N. Valid values of N: 1 to 100. Specify multiple resource IDs in the form of a repeated list. Valid values:

  • When the ResourceType parameter is set to instance, the ResourceId.N parameter specifies the ID of ECS instance N.
  • When the ResourceType parameter is set to ddh, the ResourceId.N parameter specifies the ID of dedicated host N.
  • When the ResourceType parameter is set to managedhost, the ResourceId.N parameter specifies the ID of physical machine N in the SHP.

If this parameter is not specified, the system events of all resources of the resource type specified byResourceType within the region specified by RegionId are queried.

Note We recommend that you use the ResourceId.N parameter to specify one or more resource IDs. If you specify both the ResourceId.N parameter and the InstanceId parameter, the ResourceId.N parameter takes precedence.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 2

The total number of instances.

InstanceSystemEventSet Array of InstanceSystemEventType

System events of the instance.

InstanceSystemEventType
EventId String e-uf64yvznlao4jl2c****

The ID of the system event.

EventPublishTime String 2017-11-30T06:32:31Z

The time when the system event was published. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

EventFinishTime String 2017-12-01T06:35:31Z

The time when the system event ended. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

ResourceType String instance

The type of the resource. Valid values:

  • instance: ECS instance
  • ddh: dedicated host
  • managehost: physical machine in an SHP
ImpactLevel String 100

The impact level of the system event.

NotBefore String 2017-12-06T00:00:00Z

The scheduled execution time of the system event. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

InstanceId String i-uf678mass4zvr9n1****

The ID of the resource.

Reason String System maintenance is scheduled due to ***.

The reason why the system event was scheduled.

EventType Object

The type of the system event.

Name String InstanceExpiration.Stop

The name of the system event type.

Code Integer 34

The code of the system event type.

EventCycleStatus Object

The lifecycle status of the system event.

Name String Executed

The status name of the system event.

Code Integer 0

The status code of the system event.

ExtendedAttribute Object

The extended attribute of the system event.

Device String /dev/vda

The device name of the local disk.

DiskId String d-diskid1

The ID of the local disk.

InactiveDisks Array of InactiveDisk

Details about the inactive cloud or local disks that have been released but must be removed.

InactiveDisk
CreationTime String 2018-11-30T06:32:31Z

The time when the cloud or the local disk was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

DeviceSize String 80

The size of the cloud or local disk. Unit: GiB.

DeviceCategory String cloud_efficiency

The category of the cloud or local disk. Valid values:

  • cloud: basic disk
  • cloud_efficiency: ultra disk
  • cloud_ssd: standard SSD
  • cloud_essd: ESSD
  • local_ssd_pro: I/O-intensive local disk
  • local_hdd_pro: throughput-intensive local disk
  • ephemeral: retired local disk
  • ephemeral_ssd: retired local SSD
DeviceType String data

The type of the cloud or local disk. Valid values:

  • system: system disk
  • data: data disk
ReleaseTime String 2019-11-30T06:32:31Z

The time when the cloud or local disk was released. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeInstanceHistoryEvents
&RegionId=cn-hangzhou
&InstanceId=i-uf678mass4zvr9n1****
&EventId.1=e-uf64yvznlao4jl2c****
&InstanceEventCycleStatus.1=Executed
&EventCycleStatus=Executed
&InstanceEventType.1=SystemMaintenance.Reboot
&NotBefore.Start=2017-11-30T06:32:31Z
&NotBefore.End=2017-12-01T06:32:31Z
&PageNumber=1
&PageSize=1
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceHistoryEventsResponse>
    <InstanceSystemEventSet>
        <InstanceSystemEventType>
            <InstanceId>i-uf678mass4zvr9n1****</InstanceId>
            <EventId>e-uf64yvznlao4jl2c****</EventId>
            <EventType>
                <Code>1</Code>
                <Name>SystemMaintenance.Reboot</Name>
            </EventType>
            <EventCycleStatus>
                <Code>0</Code>
                <Name>Executed</Name>
            </EventCycleStatus>
            <EventPublishTime>2017-11-30T06:32:31Z</EventPublishTime>
            <NotBefore>2017-12-01T06:32:31Z</NotBefore>
            <EventFinishTime>2017-12-01T06:35:31Z</EventFinishTime>
            <ResourceType>instance</ResourceType>
        </InstanceSystemEventType>
        <InstanceSystemEventType>
            <InstanceId>i-uf678mass4zvr9n1****</InstanceId>
            <EventId>e-uf61cbvp0w8x2xfx****</EventId>
            <EventType>
                <Code>34</Code>
                <Name>InstanceExpiration.Stop</Name>
            </EventType>
            <EventCycleStatus>
                <Code>8</Code>
                <Name>Avoided</Name>
            </EventCycleStatus>
            <EventPublishTime>2017-11-29T06:32:31Z</EventPublishTime>
            <NotBefore>2017-12-06T00:00:00Z</NotBefore>
            <EventFinishTime>2017-12-05T12:35:31Z</EventFinishTime>
            <ResourceType>instance</ResourceType>
        </InstanceSystemEventType>
    </InstanceSystemEventSet>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <RequestId>02EA76D3-5A2A-44EB-XXXX-8901881D8707</RequestId>
</DescribeInstanceHistoryEventsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "InstanceSystemEventSet" : {
    "InstanceSystemEventType" : [ {
      "InstanceId" : "i-uf678mass4zvr9n1****",
      "EventId" : "e-uf64yvznlao4jl2c****",
      "EventType" : {
        "Code" : 1,
        "Name" : "SystemMaintenance.Reboot"
      },
      "EventCycleStatus" : {
        "Code" : 0,
        "Name" : "Executed"
      },
      "EventPublishTime" : "2017-11-30T06:32:31Z",
      "NotBefore" : "2017-12-01T06:32:31Z",
      "EventFinishTime" : "2017-12-01T06:35:31Z",
      "ResourceType" : "instance"
    }, {
      "InstanceId" : "i-uf678mass4zvr9n1****",
      "EventId" : "e-uf61cbvp0w8x2xfx****",
      "EventType" : {
        "Code" : 34,
        "Name" : "InstanceExpiration.Stop"
      },
      "EventCycleStatus" : {
        "Code" : 8,
        "Name" : "Avoided"
      },
      "EventPublishTime" : "2017-11-29T06:32:31Z",
      "NotBefore" : "2017-12-06T00:00:00Z",
      "EventFinishTime" : "2017-12-05T12:35:31Z",
      "ResourceType" : "instance"
    } ]
  },
  "PageSize" : 10,
  "PageNumber" : 1,
  "TotalCount" : 2,
  "RequestId" : "02EA76D3-5A2A-44EB-XXXX-8901881D8707"
}

Error codes

HTTP status code Error code Error message Description
403 InvalidParameter %s The error message returned because the specified parameter is invalid.
403 EventIdLimitExceeded %s The error message returned because more than 100 events are specified.
403 InvalidParameter.TimeEndBeforeStart %s The error message returned because the specified parameter is invalid. Check whether the end time is earlier than the start time.
403 OperationDenied.NotInWhiteList %s The error message returned because you are not authorized to perform this operation. Try again when you are authorized.
404 MissingParameter %s The error message returned because a required parameter is not specified.

For a list of error codes, visit the API Error Center.