CreatePlanMaintenanceWindow - Elastic Compute Service

建立維運視窗。當維運視窗 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 : 重新部署。 PerformanceImpact : 效能抖動。 Reboot : 重新啟動。	Reboot
RegionId	string	是	地域 ID。因為阿里雲 SDK 路由需要為必填參數。但是對該介面設定任意 regionId 沒有差異，維運窗口會對全網滿足資源過濾條件的 ECS 生效。	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 參數設定錯誤。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。