接口说明
修改运维窗口的属性。当运维窗口 TargetResource 参数设置关联的 ECS 实例,底层发生硬件隐患,需要通过计划运维来规避的时候,计划运维的执行时间会根据运维窗口 TimePeriod 参数设置的区间来设置。当到达运维事件的执行时间后,平台会自动根据运维事件的类型来执行响应的运维操作
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecs:ModifyPlanMaintenanceWindow | update | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PlanWindowId | string | 是 | 需要修改的运维窗口的 Id。必传参数。 | pw-bp1au1w8v8a1yer65g5k |
| PlanWindowName | string | 否 | 运维创建名称,无需修为空。 | WIndowName |
| Enable | boolean | 否 | 启用或禁用窗口。无需修改为空。 | false |
| SupportMaintenanceAction | string | 否 | 支持的运维动作。无需修改为空。 | Reboot |
| RegionId | string | 是 | 实例所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
| TimePeriod | object | 否 | 窗口循环周期。无需修改为空。 | |
| PeriodUnit | string | 否 | 周期的类型,每日循环 Daily,每周循环 Weekly。 | Year |
| RangeList | array<object> | 否 | 运维窗口循环周期的时间段(UTC 时区) | |
| object | 否 | |||
| StartTime | string | 否 | 运维窗口的开始时间 PeriodUnit 取值 Weekly 窗口期格式为 Monday,22:00 ,Monday 可替换为:Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday PeriodUnit 取值 Daily 窗口期格式为 22:00,Daily 第一部分表达为小时,取值 00~23 | Monday,22:00 |
| EndTime | string | 否 | 运维窗口的结束时间 PeriodUnit 取值 Weekly 窗口期格式为 Monday,22:00,Monday 可替换为:Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday PeriodUnit 取值 Daily 窗口期格式为 22:00 ,Daily 第一部分表达为小时,取值 00~23 | Tuesday,03:00 |
| TargetResource | object | 否 | 运维窗口生效的资源,无需修改为空 | |
| Scope | string | 否 | 配置运维窗口的资源类型 | Tag |
| ResourceGroupId | string | 否 | 运维窗口生效的资源组 ID。仅在 Scope 为 ResourceGroup 时需要填写 | rg-acfmy4cc27vsvia |
| Tags | array<object> | 否 | 运维窗口生效的标签,仅在 Scope 为 Tag 时需要填写 | |
| object | 否 | |||
| Key | string | 否 | 窗口生效的 tag 的 Key | tagKey |
| Value | string | 否 | 窗口生效的 tag 的 value | tagValue |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "F3CD6886-D8D0-4FEE-B93E-1B732396****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | AccessForbidden | User not authorized to operate on the specified resource. | 您未被授权使用指定的资源。 |
| 403 | InvalidParameter.TimePeriod | Invalid Parameter Time Period. | Time Period 属性错误。 |
| 403 | InvalidParameter.TargetResource | Invalid Parameter Target Resource. | TargetResource 属性设置错误。 |
| 403 | InvalidParameter.SupportMaintenanceAction | Invalid Parameter SupportMaintenanceAction. | SupportMaintenanceAction 属性设置错误。 |
| 404 | InvalidResource.NotFound | The specified resource not exists. | 指定的资源不存在 |
| 500 | InternalError | Internal error. | 发生未知错误。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2026-02-02 | 新增 OpenAPI | 查看变更详情 |
