检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
什么是代码检查 代码检查（CodeArts Check）是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上，为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力，提供全面质量报告、便捷闭环处理问题，帮助企业有效管控代码质量，助力企业成功。
创建代码检查任务 代码检查服务可检查不同代码仓的代码质量，在创建代码检查任务前，需满足以下条件： 已新建CodeArts项目。 如果使用的是代码托管服务（CodeArts Repo）的代码仓库，则可以参考代码托管服务的“用户指南 > 新建Repo代码仓库”，完成新建代码仓库。 如
查询缺陷详情的统计 功能介绍 根据检查任务ID查询缺陷详情的统计 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-statistic 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务I
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新
历史扫描结果查询 功能介绍 提供每次扫描的问题数量统计 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/checkrecord 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
配置代码检查任务预置规则集 规则集则是一组用于做代码检查的规则组成的集合。一般根据不同的检查目标和需求，规则集也有相应的分类，比如对安全类、安卓应用、编程风格，使用这些类别进行检查的时候，规则集内的规则也会有所不同。 用户可根据实际需要更换代码检查任务使用的规则集，新启用的规则集将在下一次执行检查时生效。
CodeArts Check通过调用API执行MR增量检查 应用场景 在用户实际的使用场景中，用户往往有构建自己的代码质量管控平台，集成代码检查及其他检查项的需求。并且在用户的应用场景中，MR合入过程中的质量监控是一个高频应用场景。 本示例介绍如何通过调用CodeArtsCheck
查询缺陷概要 功能介绍 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_id
任务配置高级配置 功能介绍 任务配置高级配置，如自定义镜像 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，每个Code
任务配置屏蔽目录 功能介绍 任务配置屏蔽目录 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-ignorepath 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询cmetrics缺陷概要 功能介绍 根据检查任务ID查询cmetrics缺陷概要。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/metrics-summary 表1 路径参数 参数 是否必选 参数类型 描述
修改任务规则集 功能介绍 修改任务规则集。 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/ruleset 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个Cod
任务配置检查参数 功能介绍 任务配置检查参数 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-parameters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
删除检查任务 功能介绍 删除检查任务，执行中的任务删除无法再查看 调用方法 请参见如何调用API。 URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header参数
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个C
新建检查任务 功能介绍 新建检查任务但是不执行。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，每个CodeArts首页下的项目都有1个唯一的项目ID
删除自定义规则集 功能介绍 删除自定义规则集，正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
