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

获取代码度量不同范围内文件数量 - FilterMeasureTotal

功能介绍

统计代码圈复杂度、重复率在各个范围内的文件数量。

调用方法

请参见如何调用API。

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:getReport

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

POST /v1/measure/measure-total

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Language

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

  • zh-cn：中文。

  • en-us：英文。

默认取值：

zh-cn。

表2 请求Body参数

参数

是否必选

参数类型

描述

taskId

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

jobId

否

String

参数解释：

执行ID，来自代码检查执行任务接口的返回值，每次执行代码检查任务都有唯一的执行ID。版本级不传，门禁级必传。即“根据任务ID查询任务执行记录”的响应中的ID字段。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

search

否

String

参数解释：

搜索文件的关键字。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释：

响应状态。

取值范围：

  • success：成功。

  • error：失败。

result

FilterMeasureTotal object

参数解释：

代码度量不同范围内文件数量。

约束限制：

不涉及。

表4 FilterMeasureTotal

参数

参数类型

描述

ratioBigTotal

Integer

参数解释：

文件代码重复率>15%的文件数量。

取值范围：

不涉及。

ratioSmallTotal

Integer

参数解释：

文件代码重复率≤15%的文件数量。

取值范围：

不涉及。

complexityBigTotal

Integer

参数解释：

文件圈复杂度>5的文件数量。

取值范围：

不涉及。

complexitySmallTotal

Integer

参数解释：

文件圈复杂度≤5的文件数量。

取值范围：

不涉及。

commentRatio

Integer

参数解释：

注释率。仅统计C/C++、Java和JavaScript文件。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

查询ID为897acf5exxx48a5013cd的任务最新一次版本级扫描的代码圈复杂度、重复率在各个范围内的文件数量。

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

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

响应示例

状态码：200

代码度量不同范围内文件数量响应体

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

状态码：400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码：401

Unauthorized

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

状态码

状态码

描述

200

代码度量不同范围内文件数量响应体

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 代码度量

相关文档