调用ListPatchPlans接口，获取补丁计划信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ListPatchPlans

要执行的操作，取值：ListPatchPlans。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

PatchPlanIds string[] 可选示例值：["id-abc123"]

补丁计划ID列表，您可以通过调用CreatePatchPlan接口获取补丁计划ID。取值：

多个补丁计划ID之间使用“,”（英文逗号）分隔。

单次最多支持传入20个补丁计划ID。

Status string 可选示例值：Pending

补丁计划状态。取值：

Pending：待处理。

Running：运行中。

Completed：已完成。

Failed：失败。

Expired：已过期。

Cancelled：已取消。

NextToken string 可选示例值：token-abc123

分页查询凭证，用于标记分页的位置，下次查询时，取值为上一次API调用返回的NextToken参数值。

若调用时传入Token值，则取自当前页返回结果。

若调用时未传入Token值：

当查询结果存在后续分页，返回结果中将包含有效的分页Token。

当当前页为最后一页（无后续数据），返回的Token值为空字符串。

MaxResults integer 可选示例值：10

分页查询时设置的每页行数，取值：

默认值：10

取值范围：1~100

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

NextToken string 示例值：token-abc123

本次调用返回的查询凭证值。

若调用时传入Token值，则取自当前页返回结果。

若调用时未传入Token值：

当查询结果存在后续分页，返回结果中将包含有效的分页Token。

当当前页为最后一页（无后续数据），返回的Token值为空字符串。

PatchPlans object[] 示例值：--

补丁计划列表。

Name string 示例值：PlanName

补丁计划名称。

Status string 示例值：Pending

补丁计划状态。

Pending：待处理。

Running：运行中。

Completed：已完成。

Failed：失败。

Expired：已过期。

Cancelled：已取消。

Description string 示例值：The description.

补丁计划描述。

RepeatMode string 示例值：Once

补丁计划执行方式。取值：

Once：立即执行。

Recurrence：周期执行。

Scheduled：定时执行。

OperationType string 示例值：Scan

补丁计划执行类型。取值：

Scan：仅扫描。

Install：扫描并安装。

UpdatedAt string 示例值：2025-12-25T20:05:56Z

补丁计划更新时间。

CreatedAt string 示例值：2025-12-25T20:05:56Z

补丁计划创建时间。

MaxConcurrency string 示例值：10

在任务执行过程中，允许同时运行命令的最大实例数量。

UseDefaultBaseline boolean 示例值：true

是否使用默认补丁基线。取值：

true：使用默认补丁基线。

false：使用自定义基线。

AutoCreateSnapshot boolean 示例值：true

是否为系统盘创建快照。取值：

false：不创建快照。

true：自动为系统盘创建快照。

AutoReboot boolean 示例值：true

是否自动重启实例。

false：补丁安全完全后，未自动重启实例。

true：补丁安全完全后，已自动重启实例。

ScheduledPolicy object 示例值：--

定时/周期策略。

说明

仅当任务执行方式为定时/周期策略时有返回。

RecurrenceEndTime string 示例值：2025-12-09T20:45Z

周期任务的结束时间。

RecurrenceType string 示例值：Daily

周期任务的重复周期，取值：

Daily：按天重复执行，例如每2天执行一次。

Weekly：按周重复执行，每天执行一次。

Monthly：按月重复执行，例如每月2号至8号，每日执行一次。

Cron：按指定的Cron表达式重复执行。

LaunchTime string 示例值：2022-04-01T16:00Z

任务的触发时间。

说明

如果指定了ScheduledPolicy.RecurrenceType，则为周期任务开始时间。

当RepeatMode取值为Once时，本参数无效。

RecurrenceValue string 示例值：1

重复执行周期任务的数值。取值：字符串类型，如 "10"。

PatchPlanId string 示例值：pp-yedfvyt41q5s2jax****

补丁计划ID。

BaselineId string 示例值：bl-yec3ciz6kb9vq4m****

补丁基线ID。

MaxErrors string 示例值：10

任务执行过程中允许的最大错误实例数量。

说明

当执行失败的实例数量超过该阈值时，系统将停止向剩余未执行的实例下发命令。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidArgument	The specified argument is invalid.	指定的参数不合法。
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

云服务器