DescribePlanMaintenanceWindows - 查询运维窗口

更新时间:
复制为 MD 格式

查询运维窗口

接口说明

查询已设定的维护策略,策略中主要包括两个维护属性。

  • 维护时间窗口:您指定的一个时间段,运维只会在该时间内进行。
  • 维护动作:您指定的实例宕机处理策略。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Enableboolean

窗口启用或者禁用

true
RegionIdstring

实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
PlanWindowIdstring

运维窗口的 Id

pw-bp1jarob1aup7yvlrdt6
PlanWindowNamestring

运维窗口的名称

WIndowName
TargetResourceGroupIdstring

运维窗口生效的资源组 ID

rg-d85g5yocioezmdrll
TargetResourceTagsobject

运维窗口生效的标签

Valuestring

窗口生效的 tag 的 value

tagValue
Keystring

窗口生效的 tag 的 Key

tagKey
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。

AAAAAdDWBF2
MaxResultsinteger

分页查询时每页行数。最大值为 100。默认值:当不设置值或设置的值小于 10 时,默认值为 10。当设置的值大于 100 时,默认值为 100。

10

返回参数

名称类型描述示例值
object

Schema of Response

TotalCountinteger

TotalCount 本次请求条件下的数据总量,此参数为可选参数,默认可不返回

1
RequestIdstring

接口请求的 RequestID

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PlanMaintenanceWindowListarray<object>

创建时间。

PlanMaintenanceWindowInfoobject

目标类型。取值说明如下:

  • Tag
  • ResourceGroup
  • Instance
  • AliUid
PlanWindowIdstring

运维窗口的 ID

pw-bp1bqkbjb7h4j8zqzwvp
PlanWindowNamestring

运维窗口的名称

WindowName
Enableboolean

是否启用

true
SupportMaintenanceActionstring

支持的运维动作

Reboot
CreateTimestring

运维窗口创建时间。

按照 ISO 8601 标准表示,使用 UTC 时间。格式为:yyyy-MM-ddTHH:mm:ssZ。

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

运维窗口的修改时间。

按照 ISO 8601 标准表示,使用 UTC 时间。格式为:yyyy-MM-ddTHH:mm:ssZ。

2025-02-22 10:14:28 +0800
TimePeriodobject

窗口循环周期

PeriodUnitstring

周期的类型,每日循环 Daily,每周循环 Weekly

Year
RangeListarray<object>

运维窗口循环周期的时间段(UTC 时区)

timeWindowsobject
StartTimestring

维护时间窗口开始时间。

Monday,22:00
EndTimestring

维护时间窗口结束时间。

Monday,22:00
TargetResourceobject

运维窗口生效的资源

Scopestring

配置运维窗口的资源类型

Tag
ResourceGroupIdstring

运维窗口生效的资源组 ID

rg-aek2qxeteo7fr6y
Tagsarray<object>

运维窗口生效的标签

resourceTagsobject
Keystring

标签键。

tagKey
Valuestring

标签值。

tagValue
NextTokenstring

本次调用返回的查询凭证(Token)。

AAAAAdDWBF2
MaxResultsinteger

分页查询时每页行数。最大值为 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错误码错误信息描述
403AccessForbiddenUser not authorized to operate on the specified resource.您未被授权使用指定的资源。
500InternalErrorInternal error.发生未知错误。

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

变更历史

变更时间变更内容概要操作
2026-02-02新增 OpenAPI查看变更详情