Help Center/ CodeArts Check/ API Reference/ APIs/ Code Metrics/ Querying Duplicate Code Blocks (Version 2)
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Duplicate Code Blocks (Version 2)

Function

This API is used to query all duplicate code blocks in a file, or to query code blocks that are identical to a specified one.

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 /v2/related-duplicate-blocks

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

filePath

No

String

Definition:

File path. All duplicate code blocks in the file will be queried.

Constraints:

Set either this parameter or blockId.

Range:

N/A

Default value:

N/A

blockId

No

String

Definition:

Duplicate block ID or duplicate file ID.

Constraints:

Set either this parameter or filePath.

Range:

N/A

Default value:

N/A

startLine

No

Integer

Definition:

Start line number of the duplicate block to be deleted from the query result.

Constraints:

N/A

Range:

N/A

Default value:

N/A

duplicationType

No

String

Definition:

Duplicate type. Use this parameter together with blockId. Determine whether the duplicate block ID or duplicate file ID is used.

Constraints:

N/A

Value range:

  • duplication_code: duplicate code blocks.

  • duplication_file: duplicate files.

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

Array of DuplicationFile objects

Definition:

Result of querying duplicate code blocks.
Table 4 DuplicationFile

Parameter

Type

Description

filePath

String

Definition:

File path.

Value range:

N/A

fileName

String

Definition:

File name.

Value range:

N/A

blockInfo

Array of BlockInfo objects

Definition:

Associated duplicate information.
Table 5 BlockInfo

Parameter

Type

Description

blockId

String

Definition:

Duplicate block ID or duplicate file ID.

Value range:

N/A

duplicationType

String

Definition:

Duplicate type. Use this parameter together with blockId. Determine whether the duplicate block ID or duplicate file ID is used.

Value range:

  • duplication_code: duplicate code blocks.

  • duplication_file: duplicate files.

filePath

String

Definition:

File path.

Value range:

N/A

startLine

Integer

Definition:

Start line No. of duplicate code.

Value range:

N/A

endLine

Integer

Definition:

End line No. of duplicate code.

Value range:

N/A

Status code: 400

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

Status code: 401

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

Example Requests

  • Query all duplicate code blocks and files in the code/test.java file under task ID 897acf5exxx48a5013cd.

    POST https://{endpoint}/v1/related-duplicate-blocks

{
  "taskId" : "897acf5exxx48a5013cd",
  "file_path" : "code/test.java"
}

  • Query all code blocks identical to code block ID 1 under task ID 897acf5exxx48a5013cd.

    POST https://{endpoint}/v1/related-duplicate-blocks

{
  "taskId" : "897acf5exxx48a5013cd",
  "duplication_type" : "duplication_code",
  "block_id" : "1"
}

  • Query all files identical to file ID 1 under task ID 897acf5exxx48a5013cd.

    POST https://{endpoint}/v1/related-duplicate-blocks

{
  "taskId" : "897acf5exxx48a5013cd",
  "duplication_type" : "duplication_file",
  "block_id" : "1"
}

Example Responses

Status code: 200

Response body for querying duplicate code blocks (Version 2)

{
  "status" : "success",
  "error" : null,
  "result" : [ {
    "filePath" : "vote/assets/plugins/bootstrap-switch/test/bootstrap-switch.js",
    "fileName" : "bootstrap-switch.js",
    "blockInfo" : [ {
      "blockId" : "1",
      "duplicationType" : "duplication_file",
      "filePath" : "vote/assets/plugins/bootstrap-switch/test/bootstrap-switch.js",
      "startLine" : 0,
      "endLine" : 0
    } ]
  } ]
}

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 duplicate code blocks (Version 2)

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Code Metrics