ListTaskRuns--持续交付-火山引擎

文档中心

立即注册

导航

ListTaskRuns

最近更新时间：2024.07.02 21:03:13首次发布时间：2024.07.02 21:03:13

查询某一条流水线的某个任务的运行记录列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListTaskRuns&Version=2023-05-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListTaskRuns	公共参数，本接口值：ListTaskRuns。
Version	String	是	2023-05-01	公共参数，本接口值：2023-05-01。
WorkspaceId	String	是	7815d4783edc47c5bbd7df024ab9****	工作区 ID。
PipelineId	String	是	c3afa3f27d754ac8b6052bf3dc0b****	流水线 ID。
PipelineRunId	String	是	c9020f1a904c41e4bc25afc96316****	流水线运行 ID。
TaskId	String	是	7c9d82311f9246ccb24eae5457bd****	任务 ID。
Filter	Object TaskRunFilter	否		待查询任务执行记录列表的过滤条件。
PageSize	Integer	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。

TaskRunFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["230643959e41493d9baf6012b785****"]	按任务运行记录 ID 过滤，精确查询。
Statuses	Array of String	否	["Succeeded"]	按任务状态过滤，可选的值有： Queued：待执行 Running：运行中 Timeout：超时 Failed：失败 Succeeded：成功 Cancelled：取消

参数

类型

是否必选

示例值

描述

Ids

Array of String

否

["230643959e41493d9baf6012b785****"]

按任务运行记录 ID 过滤，精确查询。

Statuses

Array of String

否

["Succeeded"]

按任务状态过滤，可选的值有：

Queued：待执行
Running：运行中
Timeout：超时
Failed：失败
Succeeded：成功
Cancelled：取消

请求示例

POST /?Action=ListTaskRuns&Version=2023-05-01 HTTP/1.1
Content-Type:application/json
{
    "WorkspaceId":"7815d4783edc47c5bbd7df024ab9****",
    "PipelineId":"c3afa3f27d754ac8b6052bf3dc0b****",
    "PipelineRunId": "c9020f1a904c41e4bc25afc96316****",
    "TaskId":"7c9d82311f9246ccb24eae5457bd****",
     "Filter": {
        "Statuses": [
            "Succeeded"
        ]
    }
}

返回参数

参数	类型	示例值	描述
TotalCount	Integer	10	任务运行记录总数目。
Items	Array of TaskRun		任务运行记录列表。
PageSize	Integer	10	分页大小。
PageNumber	Integer	10	当前页码。

TaskRun

参数	类型	示例值	描述
Id	Integer	230643959e41493d9baf6012b785****	任务运行 ID。
TaskId	Integer	7c9d82311f9246ccb24eae5457bd****	任务 ID。
Name	String	exec-cmd	任务名称。
Status	String	Succeeded	任务状态。此处的任务不包含 Agentless 任务。 Queued：待执行 Running：运行中 Timeout：超时 Failed：失败 Succeeded：成功 Cancelled：取消
CreateTime	String	2024-04-07T11:59:08+08:00	任务创建时间。
UpdateTime	String	2024-04-07T11:59:17+08:00	任务更新时间。
StartTime	String	2024-04-07T11:59:08+08:00	任务开始时间。
FinishTime	String	2024-04-07T11:59:17+08:00	任务结束时间。
Steps	Array of TaskRunStep		任务包含的执行步骤详情。
CustomPhase	String	Waiting	Agentless 任务（当前包括人工卡点、应用部署、Kubernetes 镜像升级、Kubernetes 分批发布）的执行状态。可选的值有： Waiting：等待中 Failed：失败 Succeeded：成功 Running：运行中 Approved：同意 Rejected：拒绝 Canceled：取消
CustomContent	String		用户填写的关于 Agentless 任务的自定义内容。

TaskRun.TaskRunStep

参数	类型	示例值	描述
Name	String	git-clone-0	步骤名称。
Status	String	Succeeded	步骤状态： NotStart：未开始 Running：运行中 Succeeded：成功 Failed：失败
LogUri	String	https://cp-v2.tos-cn-beijing.volces.com/v2/log/7815d4783edc47c5bbd7df024ab****	步骤日志下载链接。
Version	String	v2	步骤日志版本，默认为 v2。
LogStatus	String	Running	步骤日志状态： Running：日志采集中 Finished：日志采集完成 Synced：日志同步完成
StartTime	String	2024-04-07T11:59:12+08:00	步骤开始时间。
FinishTime	String	2024-04-07T11:59:17+08:00	步骤结束时间。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202404071710430739950998FB2847****",
        "Action": "ListTaskRuns",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "230643959e41493d9baf6012b785****",
                "TaskId": "7c9d82311f9246ccb24eae5457bd****",
                "Name": "exec-cmd",
                "Status": "Succeeded",
                "CreateTime": "2024-04-07T11:59:08+08:00",
                "UpdateTime": "2024-04-07T11:59:17+08:00",
                "Steps": [
                    {
                        "Name": "git-clone-0",
                        "Status": "Succeeded",
                        "LogUri": "",
                        "StartTime": "2024-04-07T11:59:12+08:00",
                        "FinishTime": "2024-04-07T11:59:17+08:00",
                        "Version": "v2",
                        "LogStatus": "Synced"
                    },
                    {
                        "Name": "exec-cmd",
                        "Status": "Succeeded",
                        "LogUri": "",
                        "StartTime": "2024-04-07T11:59:17+08:00",
                        "FinishTime": "2024-04-07T11:59:17+08:00",
                        "Version": "v2",
                        "LogStatus": "Synced"
                    }
                ],
                "StartTime": "2024-04-07T11:59:08+08:00",
                "FinishTime": "2024-04-07T11:59:17+08:00",
                "CustomPhase": "",
                "CustomContent": ""
            }
        ],
        "PageSize": 10,
        "PageNumber": 1,
        "TotalCount": 1
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。