すべてのプロダクト
Search

このプロダクト

    Dedicated Host:DescribePlanMaintenanceWindows

    ドキュメントセンター

    Dedicated Host:DescribePlanMaintenanceWindows

    最終更新日:Apr 04, 2026

    メンテナンスウィンドウのクエリ

    操作説明

    設定済みのメンテナンスポリシーを照会します。これには、主に次の 2 つの属性が含まれます。

    • メンテナンスウィンドウ：ユーザーが指定した、運用保守のために予約された期間。

    • メンテナンス操作：インスタンスのダウンタイムを処理するためにユーザーが指定したポリシー。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecs:DescribePlanMaintenanceWindows

    list

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Enable

    boolean

    任意

    メンテナンスウィンドウが有効かどうかを示します。

    true
    RegionId

    string

    必須

    インスタンスが配置されているリージョンの ID。 DescribeRegions 操作を呼び出して、Alibaba Cloud の最新のリージョンリストを取得します。

    cn-hangzhou
    PlanWindowId

    string

    任意

    メンテナンスウィンドウの ID。

    pw-bp1jarob1aup7yvlrdt6
    PlanWindowName

    string

    任意

    メンテナンスウィンドウの名前。

    WIndowName
    TargetResourceGroupId

    string

    任意

    メンテナンスウィンドウが適用されるリソースグループの ID。

    rg-d85g5yocioezmdrll
    TargetResourceTags

    object

    任意

    メンテナンスウィンドウが適用されるリソースのタグ。

    Value

    string

    任意

    タグの値。

    tagValue
    Key

    string

    任意

    タグのキー。

    tagKey
    NextToken

    string

    任意

    次のページの結果を取得するために使用されるトークンです。 クエリを続行するには、このパラメーターを前の応答で返された NextToken の値に設定します。

    AAAAAdDWBF2
    MaxResults

    integer

    任意

    ページあたりのエントリ数。 有効値の範囲：1～100。 デフォルト値：10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたデータ。

    TotalCount

    integer

    クエリ条件に一致するエントリの総数。 このパラメーターはオプションであり、デフォルトでは返されません。

    1
    RequestId

    string

    リクエスト ID。

    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

    メンテナンスウィンドウの作成時刻。

    時刻は協定世界時 (UTC) で、ISO 8601 フォーマット (yyyy-MM-ddTHH:mm:ssZ) に従います。

    2025-04-11T02:20:41Z
    ModifiedTime

    string

    メンテナンスウィンドウが最後に変更された時刻。

    時刻は協定世界時 (UTC) で、ISO 8601 フォーマット (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、ResourceGroup、Instance、および AliUid。

    Tag
    ResourceGroupId

    string

    メンテナンスウィンドウが適用されるリソースグループの ID。

    rg-aek2qxeteo7fr6y
    Tags

    array<object>

    メンテナンスウィンドウが適用されるタグ。

    object

    Key

    string

    タグキー。

    tagKey
    Value

    string

    タグ値。

    tagValue
    NextToken

    string

    次のリクエストで使用して次のページの結果を取得するためのページネーショントークン。

    AAAAAdDWBF2
    MaxResults

    integer

    ページあたりのエントリ数。 値の範囲は 10 から 100 です。 デフォルト値：10。

    10

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError Internal error.
    403 AccessForbidden User not authorized to operate on the specified resource.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。