DescribeInstanceHistoryEvents-阿里云帮助中心

Invoke the DescribeInstanceHistoryEvents API and specify parameters such as InstanceId and EventType to query system event information for a specified instance. By default, this operation queries historical system events that are in a non-active state.

Operation description

You can query completed historical system events from up to the last 30 days. There is no time limit for querying incomplete system events.
When neither the EventCycleStatus nor the InstanceEventCycleStatus parameter is specified, the query results include only system events in the Avoided (event avoided), Executed (event execution completed), Canceled (event canceled), or Failed (event execution failed) status by default.
By specifying the InstanceEventCycleStatus parameter, you can also query system events in the Scheduled (awaiting execution), Executing (execution in progress), or Inquiring (inquiry in progress) status.

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

ecs:DescribeInstanceHistoryEvents

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the resource. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
RegionId	string	Yes	The region ID of the resource. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
InstanceId	string	No	The ID of the instance. If this parameter is not specified, the system events of all instances in the specified region are queried.	i-uf678mass4zvr9n1****
EventCycleStatus	string	No	The lifecycle state of the system event. This parameter takes effect only when InstanceEventCycleStatus.N is not specified. Valid values: Scheduled Avoided Executing Executed Canceled Failed Inquiring	Executed
EventType	string	No	The type of the system event. This parameter takes effect only when InstanceEventType.N 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 error. SystemFailure.Redeploy: The instance is redeployed due to a system error. SystemFailure.Delete: The instance is released due to an instance creation failure. InstanceFailure.Reboot: The instance is restarted due to an instance error. InstanceExpiration.Stop: The subscription instance is stopped due to expiration. InstanceExpiration.Delete: The subscription instance is released due to expiration. AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to an overdue payment. AccountUnbalanced.Delete: The pay-as-you-go instance is released due to an overdue payment. Note For more information, see Overview. The values of this parameter are applicable only to instance system events, but not to disk system events.	SystemMaintenance.Reboot
NotBefore.Start	string	No	The earliest scheduled start time for the system event. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-11-30T06:32:31Z
NotBefore.End	string	No	The latest scheduled end time for the system event. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-12-01T06:32:31Z
EventPublishTime.Start	string	No	The beginning of the time range in which to query published system events. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-11-30T06:32:31Z
EventPublishTime.End	string	No	The end of the time range in which to query published system events. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-12-01T06:32:31Z
ImpactLevel	string	No	Note This parameter is not publicly available.	null
PageNumber	integer	No	Note This parameter is deprecated. We recommend that you specify MaxResults or NextToken for a paged query.	1
PageSize	integer	No	Note This parameter is deprecated. We recommend that you specify MaxResults or NextToken for a paged query.	10
ResourceType	string	No	The type of the resource. Valid values: instance: ECS instance ddh: dedicated host managehost: physical machine in a smart hosting pool Default value: instance.	instance
EventId	array	No	The ID of system event N. Valid values of N: 1 to 100. You can repeat this parameter to pass multiple values.	e-uf64yvznlao4jl2c****
	string	No	The ID of system event N. Valid values of N: 1 to 100. You can repeat this parameter to pass multiple values.	e-uf64yvznlao4jl2c****
InstanceEventCycleStatus	array	No	The lifecycle state of system event N. Valid values of N: 1 to 7. You can repeat this parameter to pass multiple values. Valid values: Scheduled Avoided Executing Executed Canceled Failed Inquiring	Executed
	string	No	The lifecycle state of system event N. Valid values of N: 1 to 7. You can repeat this parameter to pass multiple values. Valid values: Scheduled Avoided Executing Executed Canceled Failed Inquiring	Executed
InstanceEventType	array	No	The type of system event N. Valid values of N: 1 to 30. You can repeat this parameter to pass multiple values. 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 error. SystemFailure.Redeploy: The instance is redeployed due to a system error. SystemFailure.Delete: The instance is released due to an instance creation failure. InstanceFailure.Reboot: The instance is restarted due to an instance error. InstanceExpiration.Stop: The subscription instance is stopped due to expiration. InstanceExpiration.Delete: The subscription instance is released due to expiration. AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to an overdue payment. AccountUnbalanced.Delete: The pay-as-you-go instance is released due to an overdue payment. Note For more information, see Overview. The values of this parameter are applicable only to instance system events, but not to disk system events.	SystemMaintenance.Reboot
	string	No	The type of system event N. Valid values of N: 1 to 30. You can repeat this parameter to pass multiple values. 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 error. SystemFailure.Redeploy: The instance is redeployed due to a system error. SystemFailure.Delete: The instance is released due to an instance creation failure. InstanceFailure.Reboot: The instance is restarted due to an instance error. InstanceExpiration.Stop: The subscription instance is stopped due to expiration. InstanceExpiration.Delete: The subscription instance is released due to expiration. AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to an overdue payment. AccountUnbalanced.Delete: The pay-as-you-go instance is released due to an overdue payment. Note For more information, see Overview. The values of this parameter are applicable only to instance system events, but not to disk system events.	SystemMaintenance.Reboot
ResourceId	array	No	The ID of resource N. Valid values of N: 1 to 100. You can repeat this parameter to pass multiple values. Valid values: When `ResourceType` is set to instance, ResourceId.N specifies the ID of instance N. When `ResourceType` is set to ddh, ResourceId.N specifies the ID of dedicated host N. When `ResourceType` is set to managedhost, ResourceId.N specifies the ID of physical machine N from a smart hosting pool. If this parameter is not specified, the system events of all resources of the type specified by `ResourceType` in the region specified by `RegionId` are queried. Note We recommend that you use `ResourceId.N` to specify one or more resource IDs. If you specify both `ResourceId.N` and `InstanceId`, `ResourceId.N` takes precedence by default.	i-uf678mass4zvr9n1****
	string	No	The ID of resource N. Valid values of N: 1 to 100. You can repeat this parameter to pass multiple values. Valid values: When `ResourceType` is set to instance, ResourceId.N specifies the ID of instance N. When `ResourceType` is set to ddh, ResourceId.N specifies the ID of dedicated host N. When `ResourceType` is set to managedhost, ResourceId.N specifies the ID of physical machine N from a smart hosting pool. If this parameter is not specified, the system events of all resources of the type specified by `ResourceType` in the region specified by `RegionId` are queried. Note We recommend that you use `ResourceId.N` to specify one or more resource IDs. If you specify both `ResourceId.N` and `InstanceId`, `ResourceId.N` takes precedence by default.	i-uf678mass4zvr9n1****
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The key of tag N of the resource.	TestKey
Value	string	No	The value of tag N of the resource.	TestValue
ResourceGroupId	string	No	The ID of the resource group to which the resource belongs.	rg-bp67acfmxazb4p****
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of NextToken.	f1c9fa9de5752***
MaxResults	integer	No	The number of entries to return on each page. Valid values: 10 to 100. Default values: If you set a value greater than 0 and less than 10, the default value is 10. If you set this parameter to a value that is greater than 100, the default value is 100.	100

Response elements

Element	Type	Description	Example
	object	The queried instance system events.
PageSize	integer	The number of entries per page. Note If MaxResults and NextToken are used to query results by page, ignore this parameter. This parameter will be removed in the future. We recommend that you use the NextToken and MaxResults parameters for a paged query.	10
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number. Note If MaxResults and NextToken are used to query results by page, ignore this parameter. This parameter will be removed in the future. We recommend that you use the NextToken and MaxResults parameters for a paged query.	1
TotalCount	integer	The total number of instances. Note If you specify the MaxResults and NextToken request parameters to perform a paged query, the value of the TotalCount response parameter is invalid.	2
InstanceSystemEventSet	object
InstanceSystemEventType	array<object>	Details about the instance system events.
	array<object>	Details about the instance system event.
EventId	string	The ID of the system event.	e-uf64yvznlao4jl2c****
EventPublishTime	string	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.	2017-11-30T06:32:31Z
EventFinishTime	string	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.	2017-12-01T06:35:31Z
ResourceType	string	The type of the resource. Valid values: instance: ECS instance ddh: dedicated host managehost: physical machine in a smart hosting pool	instance
ImpactLevel	string	The impact level of the system event.	100
NotBefore	string	The scheduled start 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.	2017-12-06T00:00:00Z
InstanceId	string	The ID of the instance.	i-uf678mass4zvr9n1****
Reason	string	The reason why the system event occurred.	System maintenance is scheduled due to ***.
EventType	object	The type of the system event.
Name	string	The name of the system event type.	InstanceExpiration.Stop
Code	integer	The code of the system event type.	34
EventCycleStatus	object	The lifecycle status of the system event.
Name	string	The state name of the system event.	Executed
Code	integer	The state code of the system event.	0
ExtendedAttribute	object	The extended attribute of the system event.
Device	string	The device name of the local disk.	/dev/vda
DiskId	string	The ID of the local disk.	d-diskid1
InactiveDisks	object
InactiveDisk	array<object>	The inactive disks that were released and whose data must be cleared.
	object	The inactive disk that was released and whose data must be cleared.
CreationTime	string	The time when the disk was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-11-30T06:32:31Z
DeviceSize	string	The size of the disk. Unit: GiB.	80
DeviceCategory	string	The category of the disk. Valid values: cloud: basic disk cloud_efficiency: ultra disk cloud_ssd: standard SSD cloud_essd: Enterprise SSD (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	cloud_efficiency
DeviceType	string	The type of the disk. Valid values: system: system disk data: data disk	data
ReleaseTime	string	The time when the disk was released. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-11-30T06:32:31Z
HostType	string	The type of the host. Valid values: ddh: dedicated host managehost: physical machine in a smart hosting pool	ddh
HostId	string	The ID of the host.	dh-bp1ewce1gk3iwv2****
MigrationOptions	object
MigrationOption	array	The migration solution of the instance. Valid value: MigrationPlan. Instances can be migrated only by using migration plans.
	string	The migration solution of the instance. Valid value: MigrationPlan. Instances can be migrated only by using migration plans.	MigrationPlan
OnlineRepairPolicy	string	The online repair policy for the damaged disk. Valid value: IsolateOnly, which indicates that damaged disks are isolated but not repaired.	IsolateOnly
Rack	string	The rack number of the cloud box.	A01
PunishType	string	The type of the penalty.	ecs_message_alert
PunishDomain	string	The illegal domain name.	1228.test.com
PunishUrl	string	The illegal URL.	http://1228.test.com/1
Code	string	The code of the security violation.	PR111
CanAccept	string	Indicates whether the event can be handled.	true
ResponseResult	string	The response result of the event. Valid values: true: The event was handled. false: The event failed to be handled.	true
MetricValue	string	Metric value.	18000
MetricName	string	Metric Name.	in_mbps
ReasonCode	string	The reason code category for the system event.	VPCMigrationEcs
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Note If the NextToken parameter is not returned when you use the MaxResults and NextToken parameters to perform a paged query, no more data is returned.	f1c9fa9de5752***

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "InstanceSystemEventSet": {
    "InstanceSystemEventType": [
      {
        "EventId": "e-uf64yvznlao4jl2c****",
        "EventPublishTime": "2017-11-30T06:32:31Z",
        "EventFinishTime": "2017-12-01T06:35:31Z",
        "ResourceType": "instance",
        "ImpactLevel": "100",
        "NotBefore": "2017-12-06T00:00:00Z",
        "InstanceId": "i-uf678mass4zvr9n1****",
        "Reason": "System maintenance is scheduled due to ***.",
        "EventType": {
          "Name": "InstanceExpiration.Stop",
          "Code": 34
        },
        "EventCycleStatus": {
          "Name": "Executed",
          "Code": 0
        },
        "ExtendedAttribute": {
          "Device": "/dev/vda",
          "DiskId": "d-diskid1",
          "InactiveDisks": {
            "InactiveDisk": [
              {
                "CreationTime": "2018-11-30T06:32:31Z",
                "DeviceSize": "80",
                "DeviceCategory": "cloud_efficiency",
                "DeviceType": "data",
                "ReleaseTime": "2019-11-30T06:32:31Z"
              }
            ]
          },
          "HostType": "ddh",
          "HostId": "dh-bp1ewce1gk3iwv2****",
          "MigrationOptions": {
            "MigrationOption": [
              "MigrationPlan"
            ]
          },
          "OnlineRepairPolicy": "IsolateOnly",
          "Rack": "A01",
          "PunishType": "ecs_message_alert",
          "PunishDomain": "1228.test.com",
          "PunishUrl": "http://1228.test.com/1",
          "Code": "PR111",
          "CanAccept": "true",
          "ResponseResult": "true",
          "MetricValue": "18000",
          "MetricName": "in_mbps"
        },
        "ReasonCode": "VPCMigrationEcs"
      }
    ]
  },
  "NextToken": "f1c9fa9de5752***"
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidParameter	%s
403	EventIdLimitExceeded	%s
403	InvalidParameter.TimeEndBeforeStart	%s	The specified parameter is invalid. Make sure that the end time is later than the start time.
403	OperationDenied.NotInWhiteList	%s	You are not authorized to perform this operation. Try again when you are authorized.
404	MissingParameter	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.