云服务器
云服务器
文档指南
请输入
- 文档首页
云服务器云服务器ECSAPI参考补丁管理GetPatchPlan - 获取补丁计划详情
复制全文
下载 pdfGetPatchPlan - 获取补丁计划详情
文档反馈
问问助手调用GetPatchPlan接口，获取补丁计划详情。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：GetPatchPlan
要执行的操作，取值：GetPatchPlan。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
PatchPlanId string 必选 示例值：pp-yedfvyt41q5s2jax****
补丁计划ID。
返回参数
UseDefaultBaseline boolean 示例值：true
是否使用默认补丁基线。取值：
- true：使用默认补丁基线。
- false：使用自定义基线。
PatchPlanId string 示例值：pp-yedfvyt41q5s2jax****
补丁计划ID。
Name string 示例值：UbuntuBase****
补丁计划名称。
Status string 示例值：Pending
补丁计划状态。取值：
- Pending：待处理。
- Running：运行中。
- Completed：已完成。
- Failed：失败。
- Expired：已过期。
- Cancelled：已取消。
BaselineId string 示例值：bl-xffsafgewgdf****
补丁基线ID。
Description string 示例值：The description of baseline.
补丁计划描述。
RepeatMode string 示例值：Once
计划执行方式。取值：
- Once：立即执行。
- Recurrence：周期执行。
- Scheduled：定时执行。
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"。
OperationType string 示例值：Scan
补丁计划执行类型。取值：
- Scan：仅扫描。
- Install：扫描并安装。
AutoCreateSnapshot boolean 示例值：true
是否为系统盘创建快照。取值：
- false：不创建快照。
- true：自动为系统盘创建快照。
AutoReboot boolean 示例值：true
是否自动重启实例。
- false：补丁安全完全后 ，未自动重启实例。
- true：补丁安全完全后 ，已自动重启实例。
TargetType string 示例值：ECS
目标实例的筛选类型。取值：
- ECS：ECS实例。
- Tag：按标签筛选目标实例。
- Project：按实例所属项目筛选目标实例。
TargetValue string 示例值：["i-xffsafgewgdf****"]
目标筛选类型对应值（JSON格式字符串），取值：
- ECS：当TargetType为ECS实例时，该值为ECS实例ID列表。最大数量为200个实例。
- Tag：当TargetType是Tag时，该值为Tag键值对列表，最大数量为10个标签。
- Project：当TargetType是Project时，该值为单个ProjectName。
MaxConcurrency string 示例值：10
在任务执行过程中，允许同时运行命令的最大实例数量。
MaxErrors string 示例值：10
任务执行过程中允许的最大错误实例数量。
说明
当执行失败的实例数量超过该阈值时，系统将停止向剩余未执行的实例下发命令。
CreatedAt string 示例值：2026-01-13T11:56:55Z
补丁计划创建时间。
UpdatedAt string 示例值：2026-01-13T11:56:55Z
补丁计划更新时间。
请求示例
POST /?Version=2020-04-01&Action=GetPatchPlan HTTP/1.1
Host: ecs.cn-beijing.volcengineapi.com
AccessKey: AK*****************
SecretKey: TXpS***************
ServiceName: ecs
Region: cn-beijing
X-Top-Account-Id: 21000*****
Content-Type: application/json
{
"PatchPlanId": "pp-87654321z****"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20260122100909090****",
"Action": "GetPatchPlan",
"Version": "2020-04-01",
"Service": "ecs",
"Region": "cn-beijing"
},
"Result": {
"PatchPlanId": "pp-87654321z****",
"Name": "Weekly-Prod-Patching",
"Status": "Running",
"BaselineId": "bl-12345678abcd****",
"OperationType": "Install",
"RepeatMode": "Recurrence",
"ScheduledPolicy": {
"RecurrenceType": "Cron",
"RecurrenceValue": "0 2 * * 0",
"LaunchTime": "2026-01-08T17:45Z",
"RecurrenceEndTime": "2026-03-08T17:45Z"
},
"TargetType": "Tag",
"TargetValue": "[{"Key":"env","Values":["prod"]}]",
"AutoReboot": true,
"AutoCreateSnapshot": true,
"MaxConcurrency": "10",
"MaxErrors": "5%",
"UseDefaultBaseline": false,
"Description": "Production environment patch on Sunday early morning every week",
"CreatedAt": "2026-01-22T14:00:00Z",
"UpdatedAt": "2026-01-22T14:00:00Z"
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidArgument | The specified argument is invalid. | 指定的参数不合法。 |
500 | InternalError | An internal error has occurred. | 内部错误，请重试。如果多次尝试失败，请提交工单。 |
最近更新时间：2026.03.03 16:14:48
这个页面对您有帮助吗？
有用
有用
无用
无用