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

Querying Check Failure Logs

Function

This API is used to query the check logs of a task based on the project ID, task ID, and execution record ID. If the execution record ID is not passed, the check logs of the latest execution of the task are queried.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition :

32-character project UUID. Obtain it by calling the API used to query the project list.

Constraints:

N/A

Value range:

1 to 32 characters.

Default value:

N/A

task_id

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

execute_id

No

String

Definition :

Execution record ID, that is, the unique ID of each version or quality gate scan. Obtain the ID by calling the API used to execute the check task.

Constraints:

N/A

Value range:

32-character UUID.

Default value:

None. If this parameter is not passed, logs of the latest check are queried.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition :

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints:

N/A

Value range:

1–100,000 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

param_info

ParamInfo object

Definition

Basic task information.

Range

N/A

log_info

Array of LogInfo objects

Definition

Failure log details.

Range

N/A
Table 5 ParamInfo

Parameter

Type

Description

url

String

Definition

Code repository address.

Range

N/A

branch

String

Definition

Repository branch scanned by a task.

Range

N/A

language

String

Definition

Rule language in the current scan of a task.

Range

N/A

exclude_dir

String

Definition

Excluded directories in a task.

Range

N/A

encode

String

Definition

This field is deprecated.

Range

N/A

compile_config

String

Definition

Partial check parameters in JSON format.

Range

N/A

rule_template

String

Definition

This field is deprecated.

Range

N/A
Table 6 LogInfo

Parameter

Type

Description

display_name

String

Definition

The name of a subtask stage displayed on the check logs page.

Range

N/A

log

String

Definition

Scan log content.

Range

N/A

level

String

Definition

This field is deprecated.

Range

N/A

analysis

String

Definition

Cause of a task failure.

Range

N/A

faq

String

Definition

This field is deprecated.

Range

N/A

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

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" : "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"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

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