检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
基本概念 表1 代码检查服务基本概念 词汇 定义 重复率 重复行数是指涉及至少一次重复的代码行数;重复块是指包含重复行的代码块(最小重复块定义:Java语言连续10行重复,其它语言10行中连续100个字符重复算一个重复块);重复率=重复行/代码总行数(不包含空行与注释)。 规则 应用于检查某类代码问题
约束与限制 购买须知 不同区域购买的资源不能跨区使用,需慎重选择。 如果已经购买了CodeArts套餐,则无需再单独购买CodeArts Check套餐。 命名限制 限制项 说明 检查任务名称 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为1~128。 规则集名称
历史扫描结果查询 功能介绍 提供每次扫描的问题数量统计 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/checkrecord 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts
获取规则列表接口 功能介绍 根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity
查询任务的高级配置 功能介绍 查询任务的高级配置 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,
查询cmetrics缺陷概要 功能介绍 根据检查任务ID查询cmetrics缺陷概要。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/metrics-summary 表1 路径参数 参数 是否必选 参数类型 描述
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
获取任务的目录树 功能介绍 获取任务的目录树 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/listpathtree 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID
查询缺陷详情的统计 功能介绍 根据检查任务ID查询缺陷详情的统计 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-statistic 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID
查询规则集列表 功能介绍 根据项目ID、语言等条件查询规则集列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts
任务配置屏蔽目录 功能介绍 任务配置屏蔽目录 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-ignorepath 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值
任务配置检查参数 功能介绍 任务配置检查参数 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-parameters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck
任务配置高级配置 功能介绍 任务配置高级配置,如自定义镜像 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查看规则集的规则列表 功能介绍 根据项目ID、规则集ID等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/ruleset/{ruleset_id}/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询任务检查失败日志 功能介绍 查询任务检查失败日志,不传execute_id则查询最近一次的检查日志 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/log-detail 表1 路径参数 参数 是否必选 参数类型
删除自定义规则集 功能介绍 删除自定义规则集,正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询分支任务列表 功能介绍 查询分支任务列表 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/branches 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个