Help Center/ CodeArts Check/ API Reference/ APIs/ Code Metrics/ Counting Files in Each Code Metric Range
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Counting Files in Each Code Metric Range

Function

This API is used to count the number of code files whose cyclomatic complexity and duplication rate are in specified ranges.

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

POST /v1/measure/measure-total

Request Parameters

Table 1 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
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

taskId

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

jobId

No

String

Definition:

Execution ID, which is returned by the API of code check task execution. Each code check task has a unique execution ID. Leave this parameter blank for a version scan and pass a value for a quality gate scan. That is, the ID field in the response of API Querying Task Execution Record by Task ID.

Constraints:

N/A

Value range:

1 to 32 characters.

Default value:

N/A

search

No

String

Definition:

Keyword for file search.

Constraints:

N/A

Range:

N/A

Default value:

N/A

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

FilterMeasureTotal object

Definition:

The number of files in each code metric range.

Constraints:

N/A
Table 4 FilterMeasureTotal

Parameter

Type

Description

ratioBigTotal

Integer

Definition:

Number of files whose code duplication rate is greater than 15%.

Value range:

N/A

ratioSmallTotal

Integer

Definition:

Number of files whose code duplication rate is no more than 15%.

Value range:

N/A

complexityBigTotal

Integer

Definition:

Number of files whose cyclomatic complexity is greater than 5.

Value range:

N/A

complexitySmallTotal

Integer

Definition:

Number of files whose cyclomatic complexity is no more than 5.

Value range:

N/A

commentRatio

Integer

Definition:

Comment line percentage. Only C/C++, JavaScript, and Java files are supported.

Value range:

N/A

Status code: 400

Table 5 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 6 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

Count the number of code files in each range of cyclomatic complexity and duplication rate in the latest version scan of task ID 897acf5exxx48a5013cd.

POST https://{endpoint}/v1/measure/measure-total

{
  "taskId" : "897acf5exxx48a5013cd",
  "jobId" : ""
}

Example Responses

Status code: 200

Response body for counting the number of files in each code metric range.

{
  "status" : "success",
  "error" : null,
  "result" : {
    "ratioBigTotal" : 891,
    "ratioSmallTotal" : 2148,
    "complexityBigTotal" : 681,
    "complexitySmallTotal" : 2358,
    "commentRatio" : 12.59
  }
}

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 counting the number of files in each code metric range.

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Code Metrics