调用DescribeInstanceHistoryEvents接口,并可以指定InstanceId、EventType等参数,查询指定实例系统事件信息,默认查询处于非活跃状态的历史系统事件。
接口说明
-
您最多可以查询最近 30 天的已完结历史系统事件。对于未完结的系统事件无查询时间限制。
-
未指定 EventCycleStatus 参数和 InstanceEventCycleStatus 参数时,查询结果默认只包括处于 Avoided(事件已避免)、Executed(事件已完成执行)、Canceled(事件已取消)和 Failed(事件执行失败)状态的系统事件。
-
通过指定 InstanceEventCycleStatus 参数,还可以查询处于 Scheduled(等待执行事件)、Executing(事件执行中)和 Inquiring(事件问询中)状态的系统事件。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:DescribeInstanceHistoryEvents |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
资源所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| RegionId |
string |
是 |
资源所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| InstanceId |
string |
否 |
实例 ID。不指定实例 ID 时,表示查询您指定地域下所有实例的系统事件信息。 |
i-uf678mass4zvr9n1**** |
| EventCycleStatus |
string |
否 |
系统事件的生命周期状态。EventCycleStatus 只在未指定 InstanceEventCycleStatus.N 参数时有效。取值范围:
|
Executed |
| EventType |
string |
否 |
系统事件的类型。EventType 参数只在未指定 InstanceEventType.N 参数时有效。取值范围:
说明
事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件,不能是磁盘系统事件。 |
SystemMaintenance.Reboot |
| NotBefore.Start |
string |
否 |
查询系统事件计划执行时间的开始时间。按照ISO 8601标准表示,并需要使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2017-11-30T06:32:31Z |
| NotBefore.End |
string |
否 |
查询系统事件计划执行时间的结束时间。按照ISO 8601标准表示,并需要使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-01T06:32:31Z |
| EventPublishTime.Start |
string |
否 |
查询系统事件发布时间的开始时间。按照ISO 8601标准表示,并需要使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2017-11-30T06:32:31Z |
| EventPublishTime.End |
string |
否 |
查询系统事件发布时间的结束时间。按照ISO 8601标准表示,并需要使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-01T06:32:31Z |
| ImpactLevel |
string |
否 |
说明
该参数暂未开放使用。 |
null |
| PageNumber |
integer |
否 |
说明
该参数即将下线,建议您通过指定 MaxResults 或 NextToken 参数使用分页方式查询。 |
1 |
| PageSize |
integer |
否 |
说明
该参数即将下线,建议您通过指定 MaxResults 或 NextToken 参数使用分页方式查询。 |
10 |
| ResourceType |
string |
否 |
资源类型。取值范围:
默认值:instance。 |
instance |
| EventId |
array |
否 |
一个或者多个系统事件 ID。N 的取值范围为 1~100,多个取值使用重复列表的形式。 |
e-uf64yvznlao4jl2c**** |
|
string |
否 |
一个或者多个系统事件 ID。N 的取值范围为 1~100,多个取值使用重复列表的形式。 |
e-uf64yvznlao4jl2c**** |
|
| InstanceEventCycleStatus |
array |
否 |
一个或者多个系统事件的生命周期状态。N 的取值范围:1~7,多个取值使用重复列表的形式。取值范围:
|
Executed |
|
string |
否 |
一个或者多个系统事件的生命周期状态。N 的取值范围:1~7,多个取值使用重复列表的形式。取值范围:
|
Executed |
|
| InstanceEventType |
array |
否 |
一个或者多个系统事件的类型。N 的取值范围:1~30,多个取值使用重复列表的形式。取值范围:
说明
事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件,不能是磁盘系统事件。 |
SystemMaintenance.Reboot |
|
string |
否 |
一个或者多个系统事件的类型。N 的取值范围:1~30,多个取值使用重复列表的形式。取值范围:
说明
事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件,不能是磁盘系统事件。 |
SystemMaintenance.Reboot |
|
| ResourceId |
array |
否 |
一个或多个资源 ID。N 的取值范围为 1~100。参数的多个取值使用重复列表的形式。取值范围:
如果不指定该参数,表示查询指定地域( 说明
推荐您使用 |
i-uf678mass4zvr9n1**** |
|
string |
否 |
一个或多个资源 ID。N 的取值范围为 1~100。参数的多个取值使用重复列表的形式。取值范围:
如果不指定该参数,表示查询指定地域( 说明
推荐您使用 |
i-uf678mass4zvr9n1**** |
|
| Tag |
array<object> |
否 |
系统事件支持的标签列表。 |
|
|
object |
否 |
系统事件支持的标签列表。 |
||
| Key |
string |
否 |
资源的标签键。 |
TestKey |
| Value |
string |
否 |
资源的标签值。 |
TestValue |
| ResourceGroupId |
string |
否 |
资源所在的资源组 ID。 |
rg-bp67acfmxazb4p**** |
| NextToken |
string |
否 |
查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 |
f1c9fa9de5752*** |
| MaxResults |
integer |
否 |
分页查询时每页的最大条目数。取值范围:10~100。 默认值:
|
100 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
查询的实例系统事件信息。 |
||
| PageSize |
integer |
输入时设置的每页行数。 说明
|
10 |
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| PageNumber |
integer |
实例事件列表页码。 说明
|
1 |
| TotalCount |
integer |
实例事件总个数。 说明
使用 MaxResults 和 NextToken 参数进行分页查询时,返回的 TotalCount 参数值无意义。 |
2 |
| InstanceSystemEventSet |
object |
||
| InstanceSystemEventType |
array<object> |
实例历史系统事件数组。 |
|
|
array<object> |
实例历史系统事件。 |
||
| EventId |
string |
系统事件 ID。 |
e-uf64yvznlao4jl2c**** |
| EventPublishTime |
string |
系统事件发布时间。按照ISO 8601标准表示,并需要使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2017-11-30T06:32:31Z |
| EventFinishTime |
string |
系统事件结束时间。按照ISO 8601标准表示,并需要使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-01T06:35:31Z |
| ResourceType |
string |
资源类型。可能值:
|
instance |
| ImpactLevel |
string |
影响级别。 |
100 |
| NotBefore |
string |
系统事件计划执行时间。按照ISO 8601标准表示,并需要使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2017-12-06T00:00:00Z |
| InstanceId |
string |
实例 ID。 |
i-uf678mass4zvr9n1**** |
| Reason |
string |
系统事件发生原因。 |
System maintenance is scheduled due to ***. |
| EventType |
object |
系统事件类型。 |
|
| Name |
string |
系统事件类型名称。 |
InstanceExpiration.Stop |
| Code |
integer |
系统事件类型代码。 |
34 |
| EventCycleStatus |
object |
系统事件的生命周期状态。 |
|
| Name |
string |
系统事件状态名称。 |
Executed |
| Code |
integer |
系统事件状态代码。 |
0 |
| ExtendedAttribute |
object |
事件扩展属性。 |
|
| Device |
string |
本地盘设备名。 |
/dev/vda |
| DiskId |
string |
本地盘 ID。 |
d-diskid1 |
| InactiveDisks |
object |
||
| InactiveDisk |
array<object> |
已释放但需要清理的非活跃云盘或本地盘信息列表。 |
|
|
object |
已释放但需要清理的非活跃云盘或本地盘信息。 |
||
| CreationTime |
string |
云盘或本地盘创建时间。按照ISO 8601标准表示,并需要使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2018-11-30T06:32:31Z |
| DeviceSize |
string |
云盘或本地盘大小,单位 GiB。 |
80 |
| DeviceCategory |
string |
云盘或本地盘种类。可能值:
|
cloud_efficiency |
| DeviceType |
string |
云盘或本地盘类型。可能值:
|
data |
| ReleaseTime |
string |
云盘或本地盘释放时间。按照ISO 8601标准表示,并需要使用 UTC +0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2019-11-30T06:32:31Z |
| HostType |
string |
宿主机类型。可能值:
|
ddh |
| HostId |
string |
宿主机 ID。 |
dh-bp1ewce1gk3iwv2**** |
| MigrationOptions |
object |
||
| MigrationOption |
array |
实例迁移选项。当前仅支持 MigrationOptions(使用迁移计划迁移)。 |
|
|
string |
实例迁移选项。当前仅支持 MigrationPlan(使用迁移计划迁移)。 |
MigrationPlan |
|
| OnlineRepairPolicy |
string |
受损云盘在线维修策略。可能值:IsolateOnly,表示仅支持隔离坏盘,不支持维修坏盘。 |
IsolateOnly |
| Rack |
string |
云盒机柜号。 |
A01 |
| PunishType |
string |
处罚类型。 |
ecs_message_alert |
| PunishDomain |
string |
安全违规域名。 |
1228.test.com |
| PunishUrl |
string |
安全违规链接。 |
http://1228.test.com/1 |
| Code |
string |
安全违规 code。 |
PR111 |
| CanAccept |
string |
事件是否可以处理。 |
true |
| ResponseResult |
string |
事件响应结果。可能值:
|
true |
| MetricValue |
string |
指标值。 |
18000 |
| MetricName |
string |
指标名称。 |
in_mbps |
| InitialNotBefore |
string |
初始系统事件计划执行时间。 |
2026-06-22T00:00:00Z |
| ReasonCode |
string |
系统事件发生原因分类代码。 |
VPCMigrationEcs |
| NextToken |
string |
本次调用返回的查询凭证值。 说明
当使用 MaxResults 和 NextToken 参数进行分页查询时未返回 NextToken,说明已经没有更多的数据要返回。 |
f1c9fa9de5752*** |
示例
正常返回示例
JSON格式
{
"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",
"InitialNotBefore": "2026-06-22T00:00:00Z"
},
"ReasonCode": "VPCMigrationEcs"
}
]
},
"NextToken": "f1c9fa9de5752***"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 403 | InvalidParameter | %s | |
| 403 | EventIdLimitExceeded | %s | |
| 403 | InvalidParameter.TimeEndBeforeStart | %s | 您输入的参数无效,请确认结束时间是否早于开始时间。 |
| 403 | OperationDenied.NotInWhiteList | %s | 该操作无效,请先加入白名单。 |
| 404 | MissingParameter | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。