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

获取代码度量文件列表 - GetMeasureList

功能介绍

根据任务ID等参数，分页获取文件的度量信息，包含文件代码重复率、重复行数、文件圈复杂度等度量指标。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:getReport

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释：

任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

约束限制：

不涉及。

取值范围：

长度为[1~128]个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

job_id

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

page_num

否

Integer

参数解释：

分页页码。

约束限制：

不涉及。

取值范围：

≥1

默认取值：

不涉及。

默认取值：

1

page_size

否

Integer

参数解释：

分页大小。

约束限制：

不涉及。

取值范围：

1-20

默认取值：

不涉及。

默认取值：

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：PYTHON语言。

  • JAVA：JAVA语言。

  • C++：C++语言。

  • CSS：CSS语言。

  • PHP：PHP语言。

  • JAVASCRIPT：JAVASCRIPT语言。

  • GO：GO语言。

  • HTML：HTML语言。

  • C#：C#语言。

  • TYPESCRIPT：TYPESCRIPT语言。

  • SHELL：SHELL语言。

  • LUA：LUA语言。

  • RUST：RUST语言。

  • KOTLIN：KOTLIN语言。

  • SCALA：SCALA语言。

  • ARKTS：ARKTS语言。

  • SQL：SQL语言。

  • CANGJIE：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

获取代码度量文件列表响应体

{
  "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.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码：401

Unauthorized

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

状态码

状态码

描述

200

获取代码度量文件列表响应体

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 代码度量

相关文档