更新时间:2025-08-25 GMT+08:00
分享

查询重复代码块信息

功能介绍

查询文件下涉及的所有重复代码块,或查询与某个重复代码块重复的其他代码块。

调用方法

请参见如何调用API

URI

GET /v1/tasks/{task_id}/related-duplicate-blocks

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

job_id

String

参数解释:

执行记录ID,即每一次执行版本级或门禁级扫描的唯一ID,主要用于查询门禁级任务。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

file_path

String

参数解释:

文件路径,查询该文件下涉及的所有重复块。

约束限制:

与block_id参数二选一。

block_id

String

参数解释:

重复块ID或重复文件ID,查询与该ID重复的所有代码块或文件。

约束限制:

与file_path参数二选一。

duplication_type

String

参数解释:

重复类型,与block_id配合使用才有效。决定查询重复代码块还是重复文件。

取值范围:

  • duplication_code,重复代码块

  • duplication_file,重复文件

offset

Integer

参数解释:

偏移量,从0开始。

约束限制:

不涉及。

limit

Integer

参数解释:

返回数量。

约束限制:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

参数解释:

语言,决定响应以哪种语言返回。

约束限制:

不涉及。

取值范围:

  • zh-cn,中文。

  • en-us,英文。

默认取值:

zh-cn

响应参数

状态码:200

Request succeeded!

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

  • 在ID为897acf5exxx48a5013cd的任务下,查询vote/assets/plugins/bootstrap-switch/test/bootstrap-switch.js文件下的所有涉及的重复代码块和重复文件。

    GET https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/related-duplicate-blocks?file_path=vote%2Fassets%2Fplugins%2Fbootstrap-switch%2Ftest%2Fbootstrap-switch.js
    
    null
  • 在ID为897acf5exxx48a5013cd的任务下,查询与ID为1的代码块重复的所有代码块。

    GET https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/related-duplicate-blocks?duplication_type=duplication_code&block_id=1
    
    null
  • 在ID为897acf5exxx48a5013cd的任务下,查询与ID为1的重复文件重复的所有文件。

    GET https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/related-duplicate-blocks?duplication_type=duplication_file&block_id=1
    
    null

响应示例

状态码:400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙,请稍后再试"
}

状态码:401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档