查询任务检查失败日志
功能介绍
查询任务检查失败日志，不传execute_id则查询最近一次的检查日志。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/tasks/{task_id}/log-detail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 项目的32位uuid，项目唯一标识，通过查询项目列表接口查询项目列表获取。 约束限制： 不涉及。 取值范围： 32位项目ID。 默认取值： 不涉及。 |
|
task_id |
是 |
String |
参数解释： 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
execute_id |
否 |
String |
参数解释： 执行记录ID，即每一次执行版本级或门禁级扫描的唯一ID。通过执行检查任务接口的返回值可获取执行记录ID。 约束限制： 不涉及。 取值范围： 32位UUID。 默认取值： 无，不传时查询任务的最近一次的检查日志。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
param_info |
ParamInfo object |
参数解释： 任务基本信息。 取值范围: 不涉及。 |
|
log_info |
Array of LogInfo objects |
参数解释： 失败日志详情。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
url |
String |
参数解释： 代码仓地址。 取值范围: 不涉及。 |
|
branch |
String |
参数解释： 任务本次扫描的代码仓分支。 取值范围: 不涉及。 |
|
language |
String |
参数解释： 任务本次扫描的规则语言。 取值范围: 不涉及。 |
|
exclude_dir |
String |
参数解释： 任务配置的排除目录信息。 取值范围: 不涉及。 |
|
encode |
String |
参数解释： 废弃字段。 取值范围: 不涉及。 |
|
compile_config |
String |
参数解释： 任务的部分检查参数json格式信息。 取值范围: 不涉及。 |
|
rule_template |
String |
参数解释： 废弃字段。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
display_name |
String |
参数解释： 检查日志页面所显示的子任务阶段名称。 取值范围: 不涉及。 |
|
log |
String |
参数解释： 扫描日志内容。 取值范围: 不涉及。 |
|
level |
String |
参数解释： 废弃字段。 取值范围: 不涉及。 |
|
analysis |
String |
参数解释： 任务失败的简要原因。 取值范围: 不涉及。 |
|
faq |
String |
参数解释： 废弃字段。 取值范围: 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v2/{project_id}/tasks/{task_id}/log-detail
响应示例
状态码：200
Request succeeded!
{
"param_info" : {
"url" : "git@xxxxxx_only00001/file.git",
"branch" : "master",
"language" : "JAVA",
"exclude_dir" : "aa",
"encode" : "",
"compile_config" : "",
"rule_template" : ""
},
"log_info" : [ {
"log" : "2023-01-04 14:31:33 Running on server:10.75.***.***\n2023-01-04 14:31:34 waiting subJob to execute\n2023-01-04 14:33:38 flush redis cache successfully!\n2023-01-04 14:33:38 all subJob finish!",
"level" : "",
"analysis" : "2023-01-04 14:31:33 Running on server:10.75.***.***\n2023-01-04 14:31:34 waiting subJob to execute\n2023-01-04 14:33:38 flush redis cache successfully!\n2023-01-04 14:33:38 all subJob finish!",
"faq" : "",
"display_name" : "sonarqube"
} ]
}
状态码：400
Bad Request
{
"error_code" : "CC.00000000",
"error_msg" : "网络繁忙，请稍后再试"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
