调用DescribeInstanceHistoryEvents接口,并可以指定InstanceId、EventType等参数,查询指定实例系统事件信息,默认查询处于非活跃状态的历史系统事件。
接口说明
-
您最多可以查询最近 30 天的已完结历史系统事件。对于未完结的系统事件无查询时间限制。
-
通过指定 InstanceEventCycleStatus 参数,还可以查询处于 Scheduled(等待执行事件)、Executing(事件执行中)和 Inquiring(事件问询中)状态的系统事件。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:DescribeInstanceHistoryEvents | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | 否 | 查询结果的页码。取值范围:正整数。 默认值:1。 | 1 |
PageSize | integer | 否 | 查询结果的分页大小。取值范围为 1~100。 默认值为 10。 | 10 |
ResourceType | string | 否 | 资源类型。取值范围:
默认值:instance。 | instance |
EventId | array | 否 | 一个或者多个系统事件 ID。N 的取值范围为 1~100,多个取值使用重复列表的形式。 | |
string | 否 | 一个或者多个系统事件 ID。N 的取值范围为 1~100,多个取值使用重复列表的形式。 | e-uf64yvznlao4jl2c**** | |
InstanceEventCycleStatus | array | 否 | 一个或者多个系统事件的生命周期状态。N 的取值范围:1~7,多个取值使用重复列表的形式。取值范围:
| |
string | 否 | 一个或者多个系统事件的生命周期状态。N 的取值范围:1~7,多个取值使用重复列表的形式。取值范围:
| Executed | |
InstanceEventType | array | 否 | 一个或者多个系统事件的类型。N 的取值范围:1~30,多个取值使用重复列表的形式。取值范围:
说明
事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件,不能是磁盘系统事件。
| |
string | 否 | 一个或者多个系统事件的类型。N 的取值范围:1~30,多个取值使用重复列表的形式。取值范围:
说明
事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件,不能是磁盘系统事件。
| SystemMaintenance.Reboot | |
ResourceId | array | 否 | 一个或多个资源 ID。N 的取值范围为 1~100。参数的多个取值使用重复列表的形式。取值范围:
如果不指定该参数,表示查询指定地域( 说明
推荐您使用 ResourceId.N 参数设置一个或多个资源 ID。如果您同时指定了ResourceId.N 参数和InstanceId 参数,系统默认优先生效ResourceId.N 参数。
| |
string | 否 | 一个或多个资源 ID。N 的取值范围为 1~100。参数的多个取值使用重复列表的形式。取值范围:
如果不指定该参数,表示查询指定地域( 说明
推荐您使用 ResourceId.N 参数设置一个或多个资源 ID。如果您同时指定了ResourceId.N 参数和InstanceId 参数,系统默认优先生效ResourceId.N 参数。
| i-uf678mass4zvr9n1**** | |
Tag | array<object> | 否 | 系统事件支持的标签列表。 | |
object | 否 | 系统事件支持的标签列表。 | ||
Key | string | 否 | 资源的标签键。 | TestKey |
Value | string | 否 | 资源的标签值。 | TestValue |
ResourceGroupId | string | 否 | 资源所在的资源组 ID。 | rg-bp67acfmxazb4p**** |
返回参数
示例
正常返回示例
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"
},
"ReasonCode": "VPCMigrationEcs"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | InvalidParameter | %s | 无效的参数。 |
403 | EventIdLimitExceeded | %s | 一次最多能指定100个模拟事件ID。 |
403 | InvalidParameter.TimeEndBeforeStart | %s | 您输入的参数无效,请确认结束时间是否早于开始时间。 |
403 | OperationDenied.NotInWhiteList | %s | 该操作无效,请先加入白名单。 |
404 | MissingParameter | %s | 缺失参数,请检查参数是否完整。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-12 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-07-13 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |