检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题： API
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下： 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下： 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置。
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括：新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括：问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括：获取规则列表接口、创建自定义规则集、查询规则集列表等。
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中“{Endpoint}”为IAM的终端节点，可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
审计与日志 审计 云审计服务（Cloud Trace Service，CTS），是华为云安全解决方案中专业的日志审计服务，提供对各种云资源操作记录的收集、存储和查询功能，可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务并创建和配置追踪器后，CT
配置CodeArts Check项目级角色权限 新增的成员需赋予指定的角色，不同角色具备的默认权限不同。各角色具备的默认权限如表1。 表1 代码检查服务默认角色权限 资源权限/角色 项目管理员 项目经理 开发人员 测试经理 测试人员 参与者 浏览者 运维经理 产品经理 系统工程师
应用示例 示例1：查询任务列表 示例2：查询缺陷概要
HE2E DevOps实践：代码检查 本文以“DevOps全流程示例项目”为例，介绍如何在项目中进完成代码检查配置。 开展实践前，需要完成创建项目和创建仓库。 预置任务简介 样例项目中预置了以下4个代码检查任务。 表1 预置任务 预置任务 任务说明 phoenix-codecheck-worker
使用预置规则检查通用Git代码仓中的代码质量 应用场景 如果您的代码存放在通用Git代码仓中，可参考本实践的操作指导完成检查代码质量。本实践为您介绍如何使用系统预置规则检查通用Git代码仓中的Java语言代码质量。 前提准备 已开通并授权使用代码检查服务授权使用代码检查服务。 通
使用自定义执行机执行代码检查任务 应用场景 当CodeArts Check提供的内置执行机不满足业务要求时，您可接入自行提供的执行机，通过注册的方式托管到CodeArts Check服务中，委托CodeArts Check服务进行调度并执行代码检查任务。本实践我们通过检查CodeArts
不上传代码到云服务的情况下使用代码检查服务 应用场景 部分用户的代码有严格的保密机制，不允许将代码上传到外部网络，用户希望仅在信任的自有执行机上完成代码扫描服务。华为云CodeArts Check为此提供本实践的扫描方案，在不上传代码到云服务的情况下使用代码检查服务检查代码问题。
查看徽标状态 执行完代码检查任务后，您可通过徽标状态查看代码健康度，并标识在代码仓库中。 代码检查服务中设置各个告警级别的影响度如下： 致命：5 严重：3 一般：1 提示：0.1 健康度=SUM ∑(告警数量*告警级别影响度)/代码量，各个健康度对应的标识如下： A：健康度<=0
支持主流开发语言 支持主流开发语言，内置9000+检查规则，便于用户开箱即用 代码检查服务支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTML/PHP/LUA/RUST/Shell/KOTLIN/SCALA/ArkTS/SQ
配置代码检查任务预置规则集 规则集则是一组用于做代码检查的规则组成的集合。一般根据不同的检查目标和需求，规则集也有相应的分类，比如对安全类、安卓应用、编程风格，使用这些类别进行检查的时候，规则集内的规则也会有所不同。 用户可根据实际需要更换代码检查任务使用的规则集，新启用的规则集将在下一次执行检查时生效。
执行代码检查任务时提示：任务正在执行，稍后重试 问题现象 执行任务失败，提示异常信息：任务正在执行，稍后重试。 原因分析 该任务正在运行，造成流水线执行失败。 处理方法 访问流水线服务首页。 在流水线任务列表页单击失败的流水线任务名称。 单击流水线任务任一执行历史。 单击代码检查插件。
身份认证与访问控制 身份认证 用户访问代码检查服务的方式有多种，包括代码检查用户界面、API、SDK，无论访问方式封装成何种形式，其本质都是通过代码检查提供的REST风格的API接口进行请求。 代码检查的接口需要经过认证请求后才可以访问成功。代码检查支持两种认证方式： Token
配置代码检查任务质量门禁 根据质量要求设置门禁阈值，即可了解您的项目是否已准备好投入生产。例如，实际的检查结果超出设置的门禁阈值，则表示当前项目还不具备生产条件。 门禁质量设置支持租户级、项目级以及任务级，优先级为租户级 > 项目级 > 任务级。入口分别如下： 租户级：进入代码检
使用Jenkins插件集成CodeArts Check执行代码检查 应用场景 Jenkins是一款由Java编写的开源的持续集成工具，它运行在Servlet容器中（例如Apache Tomcat），可以通过各种方式触发构建。例如提交给版本控制系统时被触发、通过类似Cron的机制调
配置代码检查任务集成服务 当代码托管中有分支合并时，在代码检查服务中可以设置自动检查代码检查任务，并生成一个子任务，即代码仓库中有分支合并，就会重新生成一个代码检查子任务。 配置MR检查状态 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面，在任务列表中，单击任务名称。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
