文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 代码度量/ 获取代码度量文件列表
更新时间：2025-09-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取代码度量文件列表

功能介绍

获取代码度量文件列表

调用方法

请参见如何调用API。

URI

GET /v1/tasks/{task_id}/measure-list

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

job_id

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

page_num

否

Integer

参数解释：

分页页码。

约束限制：

不涉及。

取值范围：

≥1

默认取值：

不涉及。

page_size

否

Integer

参数解释：

分页大小。

约束限制：

不涉及。

取值范围：

1-20

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Language

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

  • zh-cn，中文。

  • en-us，英文。

默认取值：

zh-cn

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释：

响应状态。

取值范围：

  • success，成功

  • error，失败

result

result object
表5 result

参数

参数类型

描述

total

Integer

参数解释：

总数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

measureProjectInfos

Array of MeasureProjectInfo objects

参数解释：

获取代码度量文件列表结果。

约束限制：

不涉及。
表6 MeasureProjectInfo

参数

参数类型

描述

id

Integer

参数解释：

度量文件ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

filePathId

String

参数解释：

文件路径ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

filePath

String

参数解释：

文件路径。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

language

String

参数解释：

编程语言。

取值范围：

  • PYTHON

  • JAVA

  • C++

  • CSS

  • PHP

  • JAVASCRIPT

  • GO

  • HTML

  • C#

  • TYPESCRIPT

  • SHELL

  • LUA

  • RUST

  • KOTLIN

  • SCALA

  • ARKTS

  • SQL

  • CANGJIE

codeDuplicationLines

String

参数解释：

代码重复行数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

rawLines

String

参数解释：

代码行数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

codeDuplicationRatio

String

参数解释：

代码重复率。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cyclomaticComplexityFile

String

参数解释：

文件圈复杂度。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

commentRatio

String

参数解释：

注释率。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询ID为897acf5exxx48a5013cd的任务的代码度量文件列表，第1页，每页20条。

GET https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/measure-list?page_num=1&page_size=20

响应示例

状态码：200

Request succeeded!

{
  "status" : "success",
  "error" : null,
  "result" : {
    "total" : "1",
    "measureProjectInfos" : [ {
      "id" : 499506,
      "filePathId" : "b4426edc-0ed5-49a1-a62a-42c970e7ff17",
      "filePath" : "worker/src/main/java/worker/Worker.java",
      "language" : "JAVA",
      "codeDuplicationLines" : "0",
      "rawLines" : "109",
      "codeDuplicationRatio" : "0%",
      "cyclomaticComplexityFile" : "14"
    } ]
  }
}

状态码：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

错误码

请参见错误码。

父主题： 代码度量

相关文档