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

Querying Code Issues

Function

This API is used to query the code issues in a version or quality gate scan.

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:getReport

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v1/defects/task-statistics

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

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:

1 to 32 characters.

Default value:

N/A

merge_id

No

String

Definition

Merge request ID or commit ID. They are used to query quality gate tasks.

Constraints

N/A

Range

N/A

Default Value

N/A

job_id

No

String

Definition

Execution record ID, that is, the unique ID of each version or quality gate scan. The ID is used to query quality gate tasks.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

Definition:

Language of the response.

Constraints:

N/A

Value range:

  • zh-cn: Chinese.

  • en-us: English.

Default value:

zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Response status.

Value range:

  • success: successful.

  • error: failed.

result

Array of GetTaskStatistics objects

Definition:

Code issues.
Table 4 GetTaskStatistics

Parameter

Type

Description

facets

Array of GetTaskStatisticsFacets objects

Definition:

Code issues in each dimension.
Table 5 GetTaskStatisticsFacets

Parameter

Type

Description

property

String

Definition:

Dimensions.

Value range:

  • rules: rules.

  • authors: issue owners

  • isNew: whether issues are new

  • statuses: issue statuses

  • severities: unresolved issue severities

  • delayStatus: issue phases

  • unresolvedAdd: number of unresolved issues

values

Array of GetTaskStatisticsFacetItem objects

Definition:

Different categories in a dimension.
Table 6 GetTaskStatisticsFacetItem

Parameter

Type

Description

val

String

Definition:

Categories in a dimension. Categories can be the issue status, issue severity, owner, or other classifications.

Range:

N/A

count

String

Definition:

Quantity.

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

Query the code issues in the latest version scan of task ID 897acf5exxx48a5013cd.

GET https://{endpoint}/v1/defects/task-statistics?task_id=897acf5exxx48a5013cd

Example Responses

Status code: 200

Response body for querying the code issue summary.

{
  "result" : {
    "facets" : [ {
      "values" : [ {
        "val" : "0",
        "count" : "9"
      }, {
        "val" : "1",
        "count" : "0"
      }, {
        "val" : "2",
        "count" : "0"
      }, {
        "val" : "3",
        "count" : "0"
      }, {
        "val" : "4",
        "count" : "0"
      }, {
        "val" : "5",
        "count" : "0"
      }, {
        "val" : "6",
        "count" : "0"
      } ],
      "property" : "statuses"
    }, {
      "values" : [ {
        "val" : "0",
        "count" : "0"
      }, {
        "val" : "1",
        "count" : "9"
      }, {
        "val" : "2",
        "count" : "0"
      }, {
        "val" : "3",
        "count" : "0"
      } ],
      "property" : "severities"
    }, {
      "values" : [ {
        "val" : "devcloud_codecheck_l00493925_01",
        "count" : "9",
        "nickName" : "devcloud_codecheck_l00493925_01"
      } ],
      "property" : "authors"
    }, {
      "values" : [ {
        "val" : "new",
        "count" : "0"
      } ],
      "property" : "isNew"
    }, {
      "values" : [ {
        "val" : "G.EXP.01-CPP Do not declare or define reserved identifiers",
        "id" : "10111f7b6d6511edab16fa163e0fa374",
        "count" : "5"
      }, {
        "val" : "G.PRE.04-CPP Ensure that the identifier used by the constant expression in the \\#if or \\#elif preprocessing directive is defined before evaluation",
        "id" : "621f02e784f511edafd1fa163ef7e846",
        "count" : "3"
      }, {
        "val" : "G.CNS.02-CPP Do not use literals that are difficult to understand",
        "id" : "fd1a79f46d6411edab16fa163e0fa374",
        "count" : "1"
      } ],
      "property" : "rules"
    }, {
      "values" : [ {
        "val" : "0",
        "count" : "9"
      }, {
        "val" : "1",
        "count" : "0"
      } ],
      "property" : "delayStatus"
    }, {
      "values" : [ {
        "val" : "unresolvedAdd",
        "count" : "0"
      } ],
      "property" : "unresolvedAdd"
    }, {
      "values" : [ {
        "val" : "0",
        "count" : "0"
      }, {
        "val" : "1",
        "count" : "9"
      }, {
        "val" : "2",
        "count" : "0"
      }, {
        "val" : "3",
        "count" : "0"
      } ],
      "property" : "severitiesUnresolved"
    }, {
      "values" : [ {
        "val" : "0",
        "count" : "0"
      }, {
        "val" : "1",
        "count" : "0"
      }, {
        "val" : "2",
        "count" : "0"
      }, {
        "val" : "3",
        "count" : "0"
      } ],
      "property" : "severitiesNew"
    } ]
  },
  "status" : "success"
}

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

Response body for querying the code issue summary.

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Code Issues