文档中心

云服务器

请输入

补丁管理

ListPatchPlanTasks - 查询补丁计划运行任务列表

调用ListPatchPlanTasks接口，获取补丁计划运行任务信息。

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：ListPatchPlanTasks

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

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

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

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

补丁计划ID。

您可以通过调用CreatePatchPlan接口获取。取值：单次仅支持上传1个补丁计划ID。

NextToken string 可选示例值：token-abc123

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

MaxResults integer 可选示例值：10

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

默认值：10

取值范围：1~100

返回参数

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

NextToken string 示例值：token-abc123

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

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

若调用时未传入Token值：

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

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

PatchPlanTasks object[] 示例值：--

补丁计划执行任务列表。

PatchPlanTaskId string 示例值：pt-yedfvyt41r5s2kp****

执行任务ID。

FailedReason string 示例值：InvalidInstanceId.Unregister: The specified instance is unregister. status code: 400, request id: 20260113195655A2DE583E04424FC****

任务运行失败原因。

CreatedAt string 示例值：2026-01-13T11:56:55Z

任务创建时间。

UpdatedAt string 示例值：2026-01-13T11:56:55Z

任务更新时间。

Status string 示例值：Success

任务执行状态。取值：

Running：运行中。

Success：成功。

PartialSuccess：部分成功。

Failed：失败。

Skipped：已跳过。

Unknown：未知。

InvocationIds string[] 示例值：ivk-yee2zezhnvgv630g****

云助手ID列表。

请求示例

POST /?Version=2020-04-01&Action=ListPatchPlanTasks 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-87654321zyx****",​
    "MaxResults": 10​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "202601221012121212****",​
        "Action": "ListPatchPlanTasks",​
        "Version": "2020-04-01",​
        "Service": "ecs",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "PatchPlanTasks": [​
            {​
                "PatchPlanTaskId": "pt-task1****",​
                "InvocationIds": ["ivk-cloudassis****"],​
                "Status": "Success",​
                "FailedReason": "",​
                "CreatedAt": "2026-01-25T02:00:00Z",​
                "UpdatedAt": "2026-01-25T02:30:00Z"​
            }​
        ],​
        "NextToken": ""​
    }​
}​

错误码

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

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

最近更新时间：2026.03.03 16:14:47

这个页面对您有帮助吗？

有用

无用