文档首页/ 弹性云服务器 ECS/ API参考/ API/ 计划事件/ 查询计划事件列表 - ListScheduledEvents
更新时间:2026-02-04 GMT+08:00
分享

查询计划事件列表 - ListScheduledEvents

功能介绍

获取实例的事件列表。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

ecs:instanceScheduledEvents:list

list

-

-

-

-

URI

GET /v3/{project_id}/instance-scheduled-events

参数说明请参见表1

表1 路径参数

参数

是否必选

描述

project_id

项目ID。

获取方法请参见获取项目ID

表2 查询参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释:

查询返回实例事件的数量限制。

约束限制:

不涉及

取值范围:

1-100

默认取值:

不涉及

marker

String

参数解释:

取值为上一页数据的最后一条记录的唯一标识。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

id

String

参数解释:

实例事件ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

instance_id

String

参数解释:

实例ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

type

Array of strings

参数解释:

实例事件类型。

约束限制:

不涉及

取值范围:

  • instance-reboot:实例重启
  • instance-stop:实例关机
  • instance-migrate:实例迁移
  • instance-redeploy:实例重部署
  • localdisk-recovery:本地盘换盘
  • system-maintenance:系统维护

详情请参见事件概述

默认取值:

不涉及

state

Array of string

参数解释:

实例事件状态。

约束限制:

不涉及

取值范围:

  • inquiring: 待授权,需要用户对事件操作进行授权,授权时支持指定开始时间,系统将会在一定时间内完成操作,详细内容,请参见响应事件
  • scheduled:待执行,等待系统资源调度中。
  • executing:执行中,系统已完成资源调度,正在修复中。
  • completed:执行成功,系统已完成事件执行。 请验证业务受损情况,如遇异常,请联系技术支持。
  • failed:执行失败,系统自动修复失败。
  • canceled:取消,该事件已被系统取消

详情请参见事件概述

默认取值:

不涉及

publish_since

String

参数解释:

事件发布开始时间,按照时间范围过滤。

约束限制:

按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

取值范围:

不涉及

默认取值:

不涉及

publish_until

String

参数解释:

事件发布结束时间,按照时间范围过滤。

约束限制:

按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

取值范围:

不涉及

默认取值:

不涉及

请求消息

响应消息

响应参数如表3所示。

表3 响应参数

参数

参数类型

描述

events

Array of objects

参数解释:

实例事件列表,详情请参见表4

取值范围:

不涉及

page_info

Object

参数解释:

页标记,详情请参见表5

取值范围:

不涉及

表4 events参数信息

参数

参数类型

描述

id

String

参数解释:

事件ID。

取值范围:

不涉及

type

String

参数解释:

事件类型。

取值范围:

  • instance-reboot:实例重启
  • instance-stop:实例关机
  • instance-migrate:实例迁移
  • instance-redeploy:实例重部署
  • localdisk-recovery:本地盘换盘
  • system-maintenance:系统维护

详情请参见事件概述

state

String

参数解释:

事件状态。

取值范围:

  • 待授权(inquiring):需要用户对事件操作进行授权, 授权时支持指定开始时间, 系统将会在一定时间内完成操作,详细内容请参见响应事件。
  • 待执行(scheduled):等待系统资源调度中。
  • 执行中(executing):系统已完成资源调度, 正在修复中。
  • 执行成功(completed):系统已完成事件执行。 请验证业务受损情况, 如遇异常,请联系技术支持。
  • 执行失败(failed):系统自动修复失败。
  • 取消(canceled):该事件已被系统取消。

publish_time

String

参数解释:

事件发布时间。

取值范围:

不涉及

start_time

String

参数解释:

事件开始时间。

取值范围:

不涉及

finish_time

String

参数解释:

事件完成时间。

取值范围:

不涉及

not_before

String

参数解释:

事件计划执行开始时间。

取值范围:

不涉及

not_after

String

参数解释:

事件计划执行完成时间。

取值范围:

不涉及

not_before_deadline

String

参数解释:

事件计划执行开始截止时间。

取值范围:

不涉及

description

String

参数解释:

事件描述。

取值范围:

不涉及

instance_id

String

参数解释:

实例ID。

取值范围:

不涉及

execute_options

Object

参数解释:

事件执行选项,详情请参见表6

取值范围:

不涉及

source

Object

参数解释:

事件来源,详情请参见表7

取值范围:

不涉及

表5 page_info参数信息

参数

参数类型

描述

next_marker

String

参数解释:

返回下一页查询地址。

取值范围:

不涉及

表6 execute_options参数信息

参数

参数类型

描述

device

String

参数解释:

本地盘设备名。

取值范围:

不涉及

wwn

String

参数解释:

本地盘挂载唯一标识。

取值范围:

不涉及

serial_number

String

参数解释:

本地盘序列号。

取值范围:

不涉及

resize_target_flavor_id

String

参数解释:

规格ID。

取值范围:

不涉及

migrate_policy

String

参数解释:

实例迁移策略。

取值范围:

不涉及

executor

String

参数解释:

执行器。

取值范围:

不涉及

表7 source参数信息

参数

参数类型

描述

type

String

参数解释:

计划事件来源类型。

取值范围:

  • platform:运维平台发起。
  • user:用户发起。

host_scheduled_event_id

String

参数解释:

主机计划事件ID。

取值范围:

不涉及

请求示例

查询计划事件列表。

GET https://{endpoint}/v3/{project_id}/instance-scheduled-events?state=inquiring,scheduled,executing&limit=1

响应示例

{
    "events": [
        {
            "id": "0ead944a-72e8-494f-89ba-5846fb7ac5c0",
            "type": "instance-redeploy",
            "state": "scheduled",
            "publish_time": "2025-03-13T12:55:36Z",
            "start_time": null,
            "finish_time": null,
            "not_before": "2025-03-21T09:22:41Z",
            "not_after": "2025-03-21T11:22:41Z",
            "not_before_deadline": "2025-03-21T09:22:41Z",
            "description": "{\"en-us\":\"As being affected by underlying hardware or system OM, ECSs will be redeployed on new hosts\"}",
            "instance_id": "c51b9e4f-0469-4c6f-ad03-22b23247b7a8"
        }
    ],
    "page_info": {
        "next_marker": "0ead944a-72e8-494f-89ba-5846fb7ac5c0"
    }
}

返回值

请参考通用请求返回值

错误码

请参考错误码

相关文档