检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括：新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括：问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括：获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1：查询任务列表 示例2：查询缺陷概要
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
配置代码检查任务规则集 配置代码检查任务预置规则集 配置代码检查任务自定义规则集 父主题： 配置代码检查任务
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题： API
快速检查CodeArts Repo代码仓库中的代码质量 在代码开发过程中，编程人员能力和代码风格不一致，会影响代码的可阅读性和可维护性，例如代码注释要求。或者在某个平台/行业的代码编写要求比较特殊等一列问题，可通过使用代码检查服务检查代码质量。 本示例为您演示检查CodeArts
查询规则集列表-V3 功能介绍 根据项目ID、语言等条件查询规则集列表，与V2接口相比，限制了分页参数大小，V2接口后续将下线。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询规则集列表 功能介绍 根据项目ID、语言等条件查询规则集列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，每个CodeArts
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，每个CodeArts
单击任务名称时提示权限不足 问题现象 在代码检查服务任务列表中，单击任务名称，提示权限不足。 原因分析 操作的用户项目权限不足，当账号的项目权限为“测试经理”、“测试人员（含跨租户）”、“浏览者（含跨租户）”时，没有访问查看代码检查任务的权限。 处理方法 联系项目管理员（项目创建者
支持主流开发语言 支持主流开发语言，内置9000+检查规则，便于用户开箱即用 代码检查服务支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTML/PHP/LUA/RUST/Shell/KOTLIN/SCALA/ArkTS/SQL
查看徽标状态 执行完代码检查任务后，您可通过徽标状态查看代码健康度，并标识在代码仓库中。 代码检查服务中设置各个告警级别的影响度如下： 致命：5 严重：3 一般：1 提示：0.1 健康度=SUM ∑(告警数量*告警级别影响度)/代码量，各个健康度对应的标识如下： A：健康度<=0.001
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值
配置代码检查任务质量门禁 根据质量要求设置门禁阈值，即可了解您的项目是否已准备好投入生产。例如，实际的检查结果超出设置的门禁阈值，则表示当前项目还不具备生产条件。 门禁质量设置支持租户级、项目级以及任务级，优先级为租户级 > 项目级 > 任务级。入口分别如下： 租户级：进入代码检查服务首页
使用Jenkins插件集成CodeArts Check执行代码检查 应用场景 Jenkins是一款由Java编写的开源的持续集成工具，它运行在Servlet容器中（例如Apache Tomcat），可以通过各种方式触发构建。例如提交给版本控制系统时被触发、通过类似Cron的机制调度
身份认证与访问控制 身份认证 用户访问代码检查服务的方式有多种，包括代码检查用户界面、API、SDK，无论访问方式封装成何种形式，其本质都是通过代码检查提供的REST风格的API接口进行请求。 代码检查的接口需要经过认证请求后才可以访问成功。代码检查支持两种认证方式： Token认证
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
