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

文档中心

立即注册

导航

持续交付

GetTaskRunLog

最近更新时间：2024.09.27 14:46:38首次发布时间：2024.07.02 21:03:14

获取任务运行日志。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	GetTaskRunLog	接口名称。当前 API 的名称为 `GetTaskRunLog`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
WorkspaceId	String	是	7815d4783edc47c5bbd7df024ab9****	工作区 ID。
PipelineId	String	是	1b91935cdd9c49cdacd0cba229b1****	流水线 ID。
PipelineRunId	String	是	9c7219420b004cccb337224fa57****	流水线运行 ID。
TaskId	String	是	94f98a65d0854daab1da06c473d5****	任务 ID。
TaskRunId	String	是	68a359ebddac482599cdf23e90ba****	任务运行 ID。
StepName	String	是	exec-cmd	步骤名称。
Offset	Long	否	0	日志读取的初始位置。默认为 0，表示从起始位置开始。
Limit	Long	否	100	日志读取的最大偏移量，单位 B。默认为 20000 B，超过 256 KB 取 256 KB。

请求示例

POST https://open.volcengineapi.com/?Action=GetTaskRunLog&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
    "WorkspaceId": "7815d4783edc47c5bbd7df024ab9****",
    "PipelineId": "1b91935cdd9c49cdacd0cba229b1****",
    "PipelineRunId": "9c7219420b004cccb337224fa57****",
    "TaskRunId": "68a359ebddac482599cdf23e90ba****",
    "TaskId": "94f98a65d0854daab1da06c473d5****",
    "StepName": "exec-cmd",
    "Limit": 100,
    "Offset": 0
}

返回参数

参数	类型	示例值	描述
LogLines	Array of String	["hello worldxxxx\n"]	日志内容。
NextOffset	Long	41	下次日志读取的初始位置。
NextLimit	Long	0	下次日志读取的偏移量。
More	Boolean	false	是否还有更多的日志。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20240129211401F21234D64B78****",
        "Action": "GetTaskRunLog",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {
        "LogLines": [
            "hello worldxxxx\n",
            "\n",
            "\n",
            "--- End of CP Log ---\n",
            "\n"
        ],
        "NextOffset": 41,
        "NextLimit": 0,
        "More": false
    }
}

错误码

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