Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying Check Failure Logs
Updated on 2024-11-28 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Check Failure Logs

Function

This API is used to query check failure logs. If execute_id is not transferred, the latest check log is queried.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/tasks/{task_id}/log-detail

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

task_id

Yes

String

Task ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

execute_id

No

String

Task execution ID.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

Media type and encoding format.

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

param_info

ParamInfo object

Task details.

log_info

Array of LogInfo objects

Log information.
Table 5 ParamInfo

Parameter

Type

Description

url

String

Repository address.

branch

String

Repository branch.

language

String

Repository language.

exclude_dir

String

Excluded directory.

encode

String

Encoding format.

compile_config

String

Compilation configuration.

rule_template

String

Rule set name.
Table 6 LogInfo

Parameter

Type

Description

display_name

String

Log title.

log

String

Log content.

level

String

Log level.

analysis

String

Log analysis.

faq

String

FAQ.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v2/{project_id}/tasks/{task_id}/log-detail

Example Responses

Status code: 200

Request succeeded!

{
  "param_info" : {
    "url" : "git@xxxxxx_only00001/file.git",
    "branch" : "master",
    "language" : "language",
    "exclude_dir" : "aa",
    "encode" : "",
    "compile_config" : "xxx",
    "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" : ""
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "Network busy. Try again later."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Task Management