全部产品
Search

搜索本产品

    云服务器 ECS：CreatePlanMaintenanceWindow - 创建运维窗口

    文档中心

    云服务器 ECS：CreatePlanMaintenanceWindow - 创建运维窗口

    更新时间：Mar 30, 2026

    创建运维窗口。当运维窗口TargetResource参数设置关联的ECS实例，底层发生硬件隐患，需要通过计划运维来规避的时候，计划运维的执行时间会根据运维窗口TimePeriod 参数设置的区间来设置。当到达运维事件的执行时间后，平台会自动根据运维事件的类型来执行响应的运维操作。

    调试

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

    授权信息

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

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

    请求参数

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

    运维窗口的名称，可以自定义。长度不超过 200 给字符

    		WIndowName
    Enableboolean是

    启用或禁用窗口

    • true：启用。
    • false：禁用。
    		true
    SupportMaintenanceActionstring是

    运维窗口支持的运维操作

    枚举值：
    • Redeploy：Redeploy。
    • Reboot：Reboot。
    		Reboot
    RegionIdstring是

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

    		cn-hangzhou
    TimePeriodobject是

    窗口循环周期

    PeriodUnitstring是

    周期的类型，每日循环 Daily,每周循环 Weekly

    		Weekly
    RangeListarray<object>是

    运维窗口循环周期的时间段（UTC 时区）

    object否

    区分对象

    StartTimestring否

    运维窗口的开始时间

    • PeriodUnit 取值 Weekly 窗口期格式为 Monday,22:00 ，Monday 可替换为：Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
    • PeriodUnit 取值 Daily 窗口期格式为 22:00,Daily 第一部分表达为小时，取值 00~23
    		Monday,22:00
    EndTimestring否

    运维窗口的结束时间

    • PeriodUnit 取值 Weekly 窗口期格式为 Monday,22:00,Monday 可替换为：Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
    • PeriodUnit 取值 Daily 窗口期格式为 22:00 ,Daily 第一部分表达为小时，取值 00~23
    		Tuesday,03:00
    TargetResourceobject是

    运维窗口生效的资源

    Scopestring是

    配置运维窗口的资源类型

    枚举值：
    • All：All。
    • Tag：Tag。
    • ResourceGroup：ResourceGroup。
    		Tag
    ResourceGroupIdstring否

    Scope 为 ResourceGroup 时需要填写 ，资源组的 ID

    		rg-aekzhm7pmnvcbty
    Tagsarray<object>否

    Scope 为 Tag 时需要填写 ，运维窗口生效的标签

    object否

    标签值。

    Keystring否

    窗口生效的 tag 的 Key

    		vms_qualification_孙总身份证_e5590864-1fef-4db2-b2a7-bd2d657fed43.png
    Valuestring否

    窗口生效的 tag 的 value

    		21.137.18.60

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    接口请求的 RequestID

    		7D5B1188-3F08-56D1-A6B2-91B267452633
    PlanWindowIdstring

    创建完成的运维窗口的 ID

    		pw-bp1a9yavgq3dgttvowun

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "7D5B1188-3F08-56D1-A6B2-91B267452633",
  "PlanWindowId": "pw-bp1a9yavgq3dgttvowun"
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidOperation.TooManyMaintenanceWindowsToo many maintenance windows.维护窗口配置数量超过200条，无法再创建新的窗口。
    403AccessForbiddenUser not authorized to operate on the specified resource.您未被授权使用指定的资源。
    403MissingParameter.PeriodThe input parameter Period is missing.缺少 Period 参数。
    403MissingParameter.TargetTypeThe input parameter TargetType is missing.缺少TargetType 参数。
    403InvalidParameter.TimePeriodInvalid Parameter Time Period.Time Period 属性错误。
    403InvalidParameter.TargetResourceInvalid Parameter Target Resource.TargetResource 属性设置错误。
    403InvalidParameter.SupportMaintenanceActionInvalid Parameter SupportMaintenanceAction.SupportMaintenanceAction 属性设置错误。
    500InternalErrorInternal error.发生未知错误。

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

    变更历史

    变更时间变更内容概要操作
    2026-02-02新增 OpenAPI查看变更详情