ListMaintainWindows - 查询静默策略列表-云监控(CMS)-阿里云帮助中心

接口说明

分页查询指定工作空间下的静默策略列表，支持按策略名称模糊匹配、按策略 ID 精确匹配、按启用状态过滤，并支持按创建时间、更新时间或启用状态排序。没有匹配项时正常返回空列表；列表项不返回 workspaceFilterSetting。

当本次返回条数达到 maxResults 时，响应可能包含非空 nextToken；非空 nextToken 仅表示可以继续查询，不保证下一页一定包含数据。nextToken 为空表示分页结束。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /maintainWindows HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
maintainWindowName	string	否	静默策略名称，模糊匹配（包含即命中）。不传表示不按名称过滤。	silence-for-release
maintainWindowId	string	否	静默策略 ID，精确匹配。不传表示不按 ID 过滤。	3ff3fbd0-8a0b-4b31-9b1c-8e3f0a2c5d71
enable	boolean	否	按启用状态过滤。取值： true：仅返回已启用的静默策略。 false：仅返回已暂停的静默策略。不传表示不按启用状态过滤。	true
workspace	string	否	工作空间名称。后端要求必填，用于隔离不同业务空间的静默策略资源。	default-cms-xxxx-cn-hangzhou
nextToken	string	否	分页游标。首次查询无需传入；后续查询可传入上一次响应中的非空 nextToken。该值不保证下一页一定包含数据。	Y21zRXZlbnRCYXNlUGFnZT0x
maxResults	integer	否	本次请求返回的最大记录条数，默认值为 20。	20
direction	string	否	排序方向。取值： asc：正序。 desc：倒序（默认值）。	desc
orderBy	string	否	排序字段，默认按创建时间排序。取值： createTime：创建时间。 updateTime：更新时间。 enable：是否启用。传入其他值时按创建时间排序。	createTime

maintainWindowName 按名称模糊匹配，maintainWindowId 按 ID 精确匹配；不传过滤条件时查询工作空间下的全部静默策略。orderBy 支持 createTime、updateTime、enable，传入其他值时按创建时间排序；direction 仅 asc 表示正序，其余取值（包括不传）均为倒序。首次查询无需传 nextToken，后续查询传入上一次响应中的非空 nextToken。

返回参数

名称	类型	描述	示例值
	object	响应内容结构。
maintainWindowList	array	静默策略列表。没有匹配项时返回空列表；列表项不包含 workspaceFilterSetting。
	MaintainWindowForView	静默策略详情对象，字段含义与 GetMaintainWindow 返回的 maintainWindow 一致。
maxResults	integer	本次请求返回的最大记录条数。	20
nextToken	string	下一页起始游标。非空时可以继续查询，但下一页仍可能为空；为空表示分页结束。	Y21zRXZlbnRCYXNlUGFnZT0y
requestId	string	本次请求的唯一 ID，用于问题排查与工单定位。	8FDE2569-626B-5176-9844-28877A0D1C36

示例

正常返回示例

JSON格式

{
  "maintainWindowList": [
    {
      "workspace": "workspace-test",
      "maintainWindowId": "123-12-312-31-23123",
      "description": "test",
      "filterSetting": {
        "expression": "1 and 2 or 3",
        "conditions": [
          {
            "op": "EQ",
            "field": "labels.alertname\t",
            "value": "CRITICAL"
          }
        ],
        "relation": "AND"
      },
      "maintainWindowName": "测试策略",
      "updateTime": "2025-05-07T02:19:05Z",
      "effectTimeRange": {
        "startTimeInMinute": 60,
        "timeZone": "+08:00",
        "dayInWeek": [
          3
        ],
        "endTimeInMinute": 360
      },
      "userId": "12312312***",
      "effective": "* * 14-18 ? * *",
      "createTime": "2025-03-11T08:21:58Z",
      "enable": true,
      "startTime": "2024-11-26 10:02:01",
      "endTime": "2024-11-26 12:02:01"
    }
  ],
  "maxResults": 20,
  "nextToken": "Y21zRXZlbnRCYXNlUGFnZT0y",
  "requestId": "8FDE2569-626B-5176-9844-28877A0D1C36"
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterInvalid	The parameter is missing or invalid. %s	参数缺失或者参数无效。
500	InternalUnknownError	The request processing has failed due to some unknown error.	服务运行错误。
403	Forbidden	You are not authorized to operate the specified resource.	没有权限，请使用RAM进行授权
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。

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

变更历史

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