更新时间:2025-09-04 GMT+08:00
分享

获取运行全量日志

功能介绍

获取运行全量日志

调用方法

请参见如何调用API

URI

GET /v1/log/{job_id}/{build_no}/real-time-log

表1 路径参数

参数

是否必选

参数类型

描述

job_id

String

参数解释

填写需要查询构建历史列表的构建任务ID。获取方法:在构建任务详情页,拷贝浏览器URL末尾的32位数字、字母组合的字符串,即为构建任务ID。

约束限制

不涉及。

取值范围

只能是英文字母和数字,长度为32个字符。

默认取值

不涉及。

build_no

Integer

参数解释

构建任务的构建编号,从1开始,每次构建递增1。

约束限制

正整数。

取值范围

只能使用数字,大于等于1。

默认取值

1

表2 Query参数

参数

是否必选

参数类型

描述

start_offset

Integer

参数解释

起始偏移量,表示从此开始查询。

约束限制

不涉及。

取值范围

只能使用数字,大于等于0。

默认取值:

0

end_offset

Integer

参数解释

结束偏移量,表示查询到此结束。

约束限制

不涉及。

取值范围

只能使用数字,大于等于0。

默认取值:

0

sort

String

参数解释

排序方式。

约束限制

不涉及。

取值范围

AES|DESC。

size

String

参数解释

可控制返回内容长度,固定1000。

约束限制

不涉及。

取值范围

只能使用数字,大于等于0。

默认取值

1000

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

结果

error

String

返回错误信息

status

String

返回状态信息

表4 result

参数

参数类型

描述

has_more

Boolean

参数解释

是否还有剩余日志标识。

约束限制

不涉及。

取值范围

true或false。

默认取值

不涉及。

start_offset

String

参数解释

日志查询起始偏移量。

约束限制

不涉及。

取值范围

数字组成。

默认取值

不涉及。

end_offset

String

参数解释

日志查询结束偏移量。

约束限制

不涉及。

取值范围

数字组成。

默认取值

不涉及。

log

String

参数解释

返回日志内容,可能会空,请再次请求。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

location

String

参数解释

日志来源。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v1/log/{job_id}/{build_no}/real-time-log

响应示例

状态码:200

OK

{
  "result" : {
    "start_offset" : 542993,
    "end_offset" : 657353,
    "log" : "[2023/12/21 15:44:18.743 GMT+08:00] [INFO] Building jar: ***//target/server-1.0 .jar\\n[2023/12/21 15:44:18.744 GMT+08:00] [INFO]...",
    "has_more" : false,
    "location" : "jenkins"
  },
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档