全部产品
Search

搜索本产品

    云服务器 ECS：DescribeInstanceHistoryEvents - 查询指定实例系统事件信息

    文档中心

    云服务器 ECS：DescribeInstanceHistoryEvents - 查询指定实例系统事件信息

    更新时间：Nov 14, 2024

    调用DescribeInstanceHistoryEvents接口，并可以指定InstanceId、EventType等参数，查询指定实例系统事件信息，默认查询处于非活跃状态的历史系统事件。

    接口说明

    • 您最多可以查询最近 30 天的已完结历史系统事件。对于未完结的系统事件无查询时间限制。

    • 通过指定 InstanceEventCycleStatus 参数，还可以查询处于 Scheduled（等待执行事件）、Executing（事件执行中）和 Inquiring（事件问询中）状态的系统事件。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    ecs:DescribeInstanceHistoryEventsget
    *全部资源
    *
      无
    		无

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    资源所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

    		cn-hangzhou
    InstanceIdstring否

    实例 ID。不指定实例 ID 时，表示查询您指定地域下所有实例的系统事件信息。

    		i-uf678mass4zvr9n1****
    EventCycleStatusstring否

    系统事件的生命周期状态。EventCycleStatus 只在未指定 InstanceEventCycleStatus.N 参数时有效。取值范围：

    • Scheduled：等待执行事件。
    • Avoided：事件已避免。
    • Executing：事件执行中。
    • Executed：事件已完成执行。
    • Canceled：事件已取消。
    • Failed：事件执行失败。
    • Inquiring：事件问询中。
    		Executed
    EventTypestring否

    系统事件的类型。EventType 参数只在未指定 InstanceEventType.N 参数时有效。取值范围：

    • SystemMaintenance.Reboot：因系统维护实例重启。
    • SystemMaintenance.Redeploy：因系统维护实例重新部署。
    • SystemFailure.Reboot：因系统错误实例重启。
    • SystemFailure.Redeploy：因系统错误实例重新部署。
    • SystemFailure.Delete：因实例创建失败实例释放。
    • InstanceFailure.Reboot：因实例错误实例重启。
    • InstanceExpiration.Stop：因包年包月期限到期，实例停止。
    • InstanceExpiration.Delete：因包年包月期限到期，实例释放。
    • AccountUnbalanced.Stop：因账号欠费，按量付费实例停止。
    • AccountUnbalanced.Delete：因账号欠费，按量付费实例释放。
    说明 事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件，不能是磁盘系统事件。
    		SystemMaintenance.Reboot
    NotBefore.Startstring否

    查询系统事件计划执行时间的开始时间。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2017-11-30T06:32:31Z
    NotBefore.Endstring否

    查询系统事件计划执行时间的结束时间。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2017-12-01T06:32:31Z
    EventPublishTime.Startstring否

    查询系统事件发布时间的开始时间。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2017-11-30T06:32:31Z
    EventPublishTime.Endstring否

    查询系统事件发布时间的结束时间。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2017-12-01T06:32:31Z
    ImpactLevelstring否
    说明 该参数暂未开放使用。
    		null
    PageNumberinteger否

    查询结果的页码。取值范围：正整数。

    默认值：1。

    		1
    PageSizeinteger否

    查询结果的分页大小。取值范围为 1~100。

    默认值为 10。

    		10
    ResourceTypestring否

    资源类型。取值范围：

    • instance：ECS 实例。
    • ddh：专有宿主机。
    • managedhost：智能全托管资源池中的物理机。

    默认值：instance。

    		instance
    EventIdarray否

    一个或者多个系统事件 ID。N 的取值范围为 1~100，多个取值使用重复列表的形式。

    string否

    一个或者多个系统事件 ID。N 的取值范围为 1~100，多个取值使用重复列表的形式。

    		e-uf64yvznlao4jl2c****
    InstanceEventCycleStatusarray否

    一个或者多个系统事件的生命周期状态。N 的取值范围：1~7，多个取值使用重复列表的形式。取值范围：

    • Scheduled：等待执行事件。
    • Avoided：事件已避免。
    • Executing：事件执行中。
    • Executed：事件已完成执行。
    • Canceled：事件已取消。
    • Failed：事件执行失败。
    • Inquiring：事件问询中。
    string否

    一个或者多个系统事件的生命周期状态。N 的取值范围：1~7，多个取值使用重复列表的形式。取值范围：

    • Scheduled：等待执行事件。
    • Avoided：事件已避免。
    • Executing：事件执行中。
    • Executed：事件已完成执行。
    • Canceled：事件已取消。
    • Failed：事件执行失败。
    • Inquiring：事件问询中。
    		Executed
    InstanceEventTypearray否

    一个或者多个系统事件的类型。N 的取值范围：1~30，多个取值使用重复列表的形式。取值范围：

    • SystemMaintenance.Reboot：因系统维护实例重启。
    • SystemMaintenance.Redeploy：因系统维护实例重新部署。
    • SystemFailure.Reboot：因系统错误实例重启。
    • SystemFailure.Redeploy：因系统错误实例重新部署。
    • SystemFailure.Delete：因实例创建失败实例释放。
    • InstanceFailure.Reboot：因实例错误实例重启。
    • InstanceExpiration.Stop：因包年包月期限到期，实例停止。
    • InstanceExpiration.Delete：因包年包月期限到期，实例释放。
    • AccountUnbalanced.Stop：因账号欠费，按量付费实例停止。
    • AccountUnbalanced.Delete：因账号欠费，按量付费实例释放。
    说明 事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件，不能是磁盘系统事件。
    string否

    一个或者多个系统事件的类型。N 的取值范围：1~30，多个取值使用重复列表的形式。取值范围：

    • SystemMaintenance.Reboot：因系统维护实例重启。
    • SystemMaintenance.Redeploy：因系统维护实例重新部署。
    • SystemFailure.Reboot：因系统错误实例重启。
    • SystemFailure.Redeploy：因系统错误实例重新部署。
    • SystemFailure.Delete：因实例创建失败实例释放。
    • InstanceFailure.Reboot：因实例错误实例重启。
    • InstanceExpiration.Stop：因包年包月期限到期，实例停止。
    • InstanceExpiration.Delete：因包年包月期限到期，实例释放。
    • AccountUnbalanced.Stop：因账号欠费，按量付费实例停止。
    • AccountUnbalanced.Delete：因账号欠费，按量付费实例释放。
    说明 事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件，不能是磁盘系统事件。
    		SystemMaintenance.Reboot
    ResourceIdarray否

    一个或多个资源 ID。N 的取值范围为 1~100。参数的多个取值使用重复列表的形式。取值范围：

    • 当ResourceType=instance时，资源 ID 表示 ECS 实例 ID。
    • 当ResourceType=ddh时，资源 ID 表示专有宿主机 ID。
    • 当ResourceType=managedhost时，资源 ID 表示智能全托管资源池中的物理机 ID。

    如果不指定该参数，表示查询指定地域（RegionId）和指定资源类型（ResourceType）下，所有资源的系统事件信息。

    说明 推荐您使用ResourceId.N参数设置一个或多个资源 ID。如果您同时指定了ResourceId.N参数和InstanceId参数，系统默认优先生效ResourceId.N参数。
    string否

    一个或多个资源 ID。N 的取值范围为 1~100。参数的多个取值使用重复列表的形式。取值范围：

    • 当ResourceType=instance时，资源 ID 表示 ECS 实例 ID。
    • 当ResourceType=ddh时，资源 ID 表示专有宿主机 ID。
    • 当ResourceType=managedhost时，资源 ID 表示智能全托管资源池中的物理机 ID。

    如果不指定该参数，表示查询指定地域（RegionId）和指定资源类型（ResourceType）下，所有资源的系统事件信息。

    说明 推荐您使用ResourceId.N参数设置一个或多个资源 ID。如果您同时指定了ResourceId.N参数和InstanceId参数，系统默认优先生效ResourceId.N参数。
    		i-uf678mass4zvr9n1****
    Tagarray<object>否

    系统事件支持的标签列表。

    object否

    系统事件支持的标签列表。

    Keystring否

    资源的标签键。

    		TestKey
    Valuestring否

    资源的标签值。

    		TestValue
    ResourceGroupIdstring否

    资源所在的资源组 ID。

    		rg-bp67acfmxazb4p****

    返回参数

    名称类型描述示例值
    object

    查询的实例系统事件信息。

    PageSizeinteger

    输入时设置的每页行数。

    		10
    RequestIdstring

    请求 ID。

    		473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    PageNumberinteger

    实例列表页码。

    		1
    TotalCountinteger

    实例总个数。

    		2
    InstanceSystemEventSetarray<object>

    实例历史系统事件数组。

    InstanceSystemEventTypeobject

    实例历史系统事件。

    EventIdstring

    系统事件 ID。

    		e-uf64yvznlao4jl2c****
    EventPublishTimestring

    系统事件发布时间。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2017-11-30T06:32:31Z
    EventFinishTimestring

    系统事件结束时间。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2017-12-01T06:35:31Z
    ResourceTypestring

    资源类型。可能值：

    • instance：ECS 实例。
    • ddh：专有宿主机。
    • managedhost：智能全托管资源池中的物理机。
    		instance
    ImpactLevelstring

    影响级别。

    		100
    NotBeforestring

    系统事件计划执行时间。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2017-12-06T00:00:00Z
    InstanceIdstring

    实例 ID。

    		i-uf678mass4zvr9n1****
    Reasonstring

    系统事件发生原因。

    		System maintenance is scheduled due to ***.
    EventTypeobject

    系统事件类型。

    Namestring

    系统事件类型名称。

    		InstanceExpiration.Stop
    Codeinteger

    系统事件类型代码。

    		34
    EventCycleStatusobject

    系统事件的生命周期状态。

    Namestring

    系统事件状态名称。

    		Executed
    Codeinteger

    系统事件状态代码。

    		0
    ExtendedAttributeobject

    事件扩展属性。

    Devicestring

    本地盘设备名。

    		/dev/vda
    DiskIdstring

    本地盘 ID。

    		d-diskid1
    InactiveDisksarray<object>

    已释放但需要清理的非活跃云盘或本地盘信息列表。

    InactiveDiskobject

    已释放但需要清理的非活跃云盘或本地盘信息。

    CreationTimestring

    云盘或本地盘创建时间。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2018-11-30T06:32:31Z
    DeviceSizestring

    云盘或本地盘大小，单位 GiB。

    		80
    DeviceCategorystring

    云盘或本地盘种类。可能值：

    • cloud：普通云盘。
    • cloud_efficiency：高效云盘。
    • cloud_ssd：SSD 盘。
    • cloud_essd：ESSD 云盘。
    • local_ssd_pro：I/O 密集型本地盘。
    • local_hdd_pro：吞吐密集型本地盘。
    • ephemeral：（已停售）本地盘。
    • ephemeral_ssd：（已停售）本地 SSD 盘。
    		cloud_efficiency
    DeviceTypestring

    云盘或本地盘类型。可能值：

    • system：系统盘。
    • data：数据盘。
    		data
    ReleaseTimestring

    云盘或本地盘释放时间。按照ISO 8601标准表示，并需要使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2019-11-30T06:32:31Z
    HostTypestring

    宿主机类型。可能值：

    • ddh：专有宿主机。
    • managedhost：智能全托管资源池中的物理机。
    		ddh
    HostIdstring

    宿主机 ID。

    		dh-bp1ewce1gk3iwv2****
    MigrationOptionsarray

    实例迁移选项。当前仅支持 MigrationOptions（使用迁移计划迁移）。

    MigrationOptionstring

    实例迁移选项。当前仅支持 MigrationPlan（使用迁移计划迁移）。

    		MigrationPlan
    OnlineRepairPolicystring

    受损云盘在线维修策略。可能值：IsolateOnly，表示仅支持隔离坏盘，不支持维修坏盘。

    		IsolateOnly
    Rackstring

    云盒机柜号。

    		A01
    PunishTypestring

    处罚类型。

    		ecs_message_alert
    PunishDomainstring

    安全违规域名。

    		1228.test.com
    PunishUrlstring

    安全违规链接。

    		http://1228.test.com/1
    Codestring

    安全违规 code。

    		PR111
    CanAcceptstring

    事件是否可以处理。

    		true
    ResponseResultstring

    事件响应结果。可能值：

    • true：事件响应成功。
    • false：事件响应失败。
    		true
    ReasonCodestring

    系统事件发生原因分类代码。

    		VPCMigrationEcs

    示例

    正常返回示例

    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"
      }
    ]
  },
  "NextToken": ""
}

    错误码

    HTTP status code错误码错误信息描述
    403InvalidParameter%s无效的参数。
    403EventIdLimitExceeded%s一次最多能指定100个模拟事件ID。
    403InvalidParameter.TimeEndBeforeStart%s您输入的参数无效，请确认结束时间是否早于开始时间。
    403OperationDenied.NotInWhiteList%s该操作无效，请先加入白名单。
    404MissingParameter%s缺失参数，请检查参数是否完整。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-11-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
    2024-08-12OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-07-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情