# 获取代码度量文件列表V2 - GetMeasureListV2 #### 功能介绍 根据任务ID等参数，分页获取文件的度量信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck:task:getReport | Read | task \* | - | - | - | | codeartscheck:task:getReport | Read | - | codeartscheck:ProjectId | - | - | #### URI POST /v2/measure/measure-list #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Language | 否 | String | **参数解释：** 语言，决定响应以哪种语言返回。 **约束限制：** 不涉及。 **取值范围：** - zh-cn：中文。 - en-us：英文。 **默认取值：** zh-cn。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | taskId | 是 | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | | jobId | 否 | String | **参数解释：** 执行ID，来自代码检查执行任务接口的返回值，每次执行代码检查任务都有唯一的执行ID。版本级不传，门禁级必传。即"根据任务ID查询任务执行记录"的响应中的ID字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | | filterType | 否 | String | **参数解释：** 筛选条件。 **约束限制：** 不涉及。 **取值范围：** - comment_ratio：注释率。 - complexitySmall：文件圈复杂度≤5。 - complexityBig：文件圈复杂度＞5。 - ratioSmall：文件代码重复率≤15%。 - ratioBig：文件代码重复率＞15%。 **默认取值：** 不涉及。 | | sortField | 否 | String | **参数解释：** 排序字段。 **约束限制：** 不涉及。 **取值范围：** - codeDuplicationRatio：文件代码重复率。 - codeDuplicationLines：重复行数。 - cyclomaticComplexityFile：文件圈复杂度。 **默认取值：** 不涉及。 | | sortType | 否 | String | **参数解释：** 排序方式。 **约束限制：** 不涉及。 **取值范围：** - ASC：升序。 - DESC：降序。 **默认取值：** 不涉及。 | | search | 否 | String | **参数解释：** 搜索文件名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | page | 否 | Integer | **参数解释：** 分页页码。 **约束限制：** 不涉及。 **取值范围：** ≥1 **默认取值：** 不涉及。 | | pageSize | 否 | Integer | **参数解释：** 分页大小。 **约束限制：** 不涉及。 **取值范围：** 1-20 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释：** 响应状态。 **取值范围：** - success：成功。 - error：失败。 | | result | [result] object | **参数解释：** 获取代码度量文件列表结果。 | 表4result | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释：** 代码度量文件列表总数。 **取值范围：** 不涉及。 | | measureProjectInfos | Array of [MeasureProjectInfo] objects | **参数解释：** 文件度量信息。 | 表5MeasureProjectInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 - 查询ID为897acf5exxx48a5013cd的任务的代码度量文件列表，第1页，每页20条。 ``` POST https://{endpoint}/v2/measure/measure-list { "page" : 1, "pageSize" : 20, "jobId" : "", "taskId" : "897acf5exxx48a5013cd", "sortField" : "", "filterType" : "", "sortType" : "", "search" : "" } ``` - 查询ID为897acf5exxx48a5013cd的任务的文件注释率列表，第1页，每页20条。 ``` POST https://{endpoint}/v2/measure/measure-list { "page" : 1, "pageSize" : 20, "jobId" : "", "taskId" : "897acf5exxx48a5013cd", "sortField" : "", "filterType" : "comment_ratio", "sortType" : "", "search" : "" } ``` #### 响应示例 **状态码：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** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功! | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。