CreatePlanMaintenanceWindow - 创建运维窗口-专有宿主机(DDH)-阿里云帮助中心

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ecs:CreatePlanMaintenanceWindow

create

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
PlanWindowName	string	是	运维窗口的名称，可以自定义。长度不超过 200 给字符	WIndowName
Enable	boolean	是	启用或禁用窗口 true：启用。 false：禁用。	true
SupportMaintenanceAction	string	是	运维窗口支持的运维操作枚举值： Redeploy : Redeploy Reboot : Reboot	Reboot
RegionId	string	是	地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
TimePeriod	object	是	窗口循环周期
PeriodUnit	string	是	周期的类型，每日循环 Daily,每周循环 Weekly 枚举值： Daily : Daily Weekly : Weekly	Weekly
RangeList	array<object>	是	运维窗口循环周期的时间段（UTC 时区）
	object	否	区分对象
StartTime	string	否	运维窗口的开始时间 PeriodUnit 取值 Weekly 窗口期格式为 Monday,22:00 。Monday 可替换为：Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday PeriodUnit 取值 Daily 窗口期格式为 22:00 。 ”，”分割符号第一部分表达为小时，取值 00~23；第二部分表示分钟，目前支持 00	Monday,22:00
EndTime	string	否	运维窗口的结束时间 PeriodUnit 取值 Weekly 窗口期格式为 Monday,22:00 。Monday 可替换为：Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday PeriodUnit 取值 Daily 窗口期格式为 22:00 。 ”，”分割符号第一部分表达为小时，取值 00~23；第二部分表示分钟，目前支持 00	Tuesday,03:00
TargetResource	object	是	运维窗口生效的资源
Scope	string	是	配置运维窗口的资源类型枚举值： All : All Tag : Tag ResourceGroup : ResourceGroup	Tag
ResourceGroupId	string	否	Scope 为 ResourceGroup 时需要填写，资源组的 ID	rg-aekzhm7pmnvcbty
Tags	array<object>	否	Scope 为 Tag 时需要填写，运维窗口生效的标签
	object	否	标签值。
Key	string	否	窗口生效的 tag 的 Key	vms_qualification_孙总身份证_e5590864-1fef-4db2-b2a7-bd2d657fed43.png
Value	string	否	窗口生效的 tag 的 value	21.137.18.60
MinMaintenanceInterval	integer	否

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	接口请求的 RequestID	7D5B1188-3F08-56D1-A6B2-91B267452633
PlanWindowId	string	创建完成的运维窗口的 ID	pw-bp1a9yavgq3dgttvowun

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

更多信息，参考变更详情。