DescribePlanMaintenanceWindows - 查詢營運視窗 - Dedicated Host

查詢營運視窗

介面說明

查詢已設定的維護策略，策略中主要包括兩個維護屬性。

維護時間視窗：您指定的一個時間段，營運只會在該時間內進行。
維護動作：您指定的執行個體宕機處理策略。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribePlanMaintenanceWindows

list

*全部資源

*

無

請求文法

GET  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
Enable	boolean	否	視窗啟用或者禁用	true
RegionId	string	是	執行個體所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
PlanWindowId	string	否	營運視窗的 Id	pw-bp1jarob1aup7yvlrdt6
PlanWindowName	string	否	營運視窗的名稱	WIndowName
TargetResourceGroupId	string	否	營運視窗生效的資源群組 ID	rg-d85g5yocioezmdrll
TargetResourceTags	object	否	營運視窗生效的標籤
Value	string	否	視窗生效的 tag 的 value	tagValue
Key	string	否	視窗生效的 tag 的 Key	tagKey
NextToken	string	否	查詢憑證（Token），取值為上一次 API 呼叫返回的 NextToken 參數值。	AAAAAdDWBF2
MaxResults	integer	否	分頁查詢時每頁行數。最大值為 100。預設值：當不設定值或設定的值小於 10 時，預設值為 10。當設定的值大於 100 時，預設值為 100。	10

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
TotalCount	integer	TotalCount 本次請求條件下的資料總量，此參數為選擇性參數，預設可不返回	1
RequestId	string	介面請求的 RequestID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PlanMaintenanceWindowList	array<object>	建立時間。
	array<object>	目標類型。取值說明如下： Tag ResourceGroup Instance AliUid
PlanWindowId	string	營運視窗的 ID	pw-bp1bqkbjb7h4j8zqzwvp
PlanWindowName	string	營運視窗的名稱	WindowName
Enable	boolean	是否啟用	true
SupportMaintenanceAction	string	支援的營運動作	Reboot
CreateTime	string	營運視窗建立時間。按照 ISO 8601 標準表示，使用 UTC 時間。格式為：yyyy-MM-ddTHH:mm:ssZ。	2025-04-11T02:20:41Z
ModifiedTime	string	營運視窗的修改時間。按照 ISO 8601 標準表示，使用 UTC 時間。格式為：yyyy-MM-ddTHH:mm:ssZ。	2025-02-22 10:14:28 +0800
TimePeriod	object	視窗重複持續時間
PeriodUnit	string	周期的類型，每日迴圈 Daily,每周迴圈 Weekly	Year
RangeList	array<object>	營運視窗重複持續時間的時間段（UTC 時區）
	object
StartTime	string	維護時間視窗開始時間。	Monday,22:00
EndTime	string	維護時間視窗結束時間。	Monday,22:00
TargetResource	object	營運視窗生效的資源
Scope	string	配置營運視窗的資源類型	Tag
ResourceGroupId	string	營運視窗生效的資源群組 ID	rg-aek2qxeteo7fr6y
Tags	array<object>	營運視窗生效的標籤
	object
Key	string	標籤鍵。	tagKey
Value	string	標籤值。	tagValue
NextToken	string	本次調用返回的查詢憑證（Token）。	AAAAAdDWBF2
MaxResults	integer	分頁查詢時每頁行數。最大值為 100。預設值：當不設定值或設定的值小於 10 時，預設值為 10。當設定的值大於 100 時，預設值為 100。	10

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PlanMaintenanceWindowList": [
    {
      "PlanWindowId": "pw-bp1bqkbjb7h4j8zqzwvp",
      "PlanWindowName": "WindowName",
      "Enable": true,
      "SupportMaintenanceAction": "Reboot",
      "CreateTime": "2025-04-11T02:20:41Z",
      "ModifiedTime": "2025-02-22 10:14:28 +0800",
      "TimePeriod": {
        "PeriodUnit": "Year",
        "RangeList": [
          {
            "StartTime": "Monday,22:00",
            "EndTime": "Monday,22:00"
          }
        ]
      },
      "TargetResource": {
        "Scope": "Tag",
        "ResourceGroupId": "rg-aek2qxeteo7fr6y",
        "Tags": [
          {
            "Key": "tagKey",
            "Value": "tagValue"
          }
        ]
      }
    }
  ],
  "NextToken": "AAAAAdDWBF2",
  "MaxResults": 10
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	Internal error.	發生未知錯誤。
403	AccessForbidden	User not authorized to operate on the specified resource.	您未被授權使用指定的資源。

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

變更歷史

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