检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题： API
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
CodeArts Check最佳实践汇总 本文汇总了基于代码检查服务（CodeArts Check）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松检查代码。 表1 CodeArts Check最佳实践一览表 最佳实践 说明 使用预置规则检查GitCode
创建代码检查任务 代码检查服务可检查不同代码仓的代码质量，在创建代码检查任务前，需满足以下条件： 已新建CodeArts项目。 如果使用的是代码托管服务（CodeArts Repo）的代码仓库，则可以参考代码托管服务的“用户指南 > 新建Repo代码仓库”，完成新建代码仓库。 如果使用的是第三方代码仓库
使用Jenkins插件集成CodeArts Check执行代码检查 应用场景 Jenkins是一款由Java编写的开源的持续集成工具，它运行在Servlet容器中（例如Apache Tomcat），可以通过各种方式触发构建。例如提交给版本控制系统时被触发、通过类似Cron的机制调度
快速检查CodeArts Repo代码仓库中的代码质量 在代码开发过程中，编程人员能力和代码风格不一致，会影响代码的可阅读性和可维护性，例如代码注释要求。或者在某个平台/行业的代码编写要求比较特殊等一列问题，可通过使用代码检查服务检查代码质量。 本示例为您演示检查CodeArts
查看代码检查结果 前提条件 您已创建并执行代码检查任务。 查看代码检查详情 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面，搜索目标任务。在任务列表页，可以查看检查任务的状态。 新问题：表示本次代码检查任务执行后新增的问题。 未解决：表示该代码检查任务未解决的问题
“代码编写、代码合并、版本发布”三层缺陷防护 “代码编写、代码合并、版本发布”三层缺陷防护，兼顾效率与质量 优秀的代码质量保障实践，往往将代码检查融入到开发作业流中，在用户代码编写、代码提交时进行自动化的审计检查，并对团队每日产出的代码进行持续编程规范和质量检查。 这一活动实践要求已是安全开发过程
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP
查询任务的已选规则集列表v3 功能介绍 查询任务的已选规则集列表v3。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值
技术类问题 执行代码检查任务时提示：任务正在执行，稍后重试 执行代码检查任务时提示：权限不足，请核对后再试 执行代码检查任务时提示：单个任务并发数超过套餐限制，任务无法下发 执行代码检查任务时提示：Cppcheck cannot tokenize the code correctly
查询缺陷概要 功能介绍 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_id
约束与限制 购买须知 不同区域购买的资源不能跨区使用，需慎重选择。 如果已经购买了CodeArts套餐，则无需再单独购买CodeArts Check套餐。 命名限制 限制项 说明 检查任务名称 支持中英文，数字，点，下划线“_”和连接符“-”。 字符长度范围为1~128。 规则集名称
示例1：查询任务列表 场景描述 本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 约束限制 无。 涉及接口 涉及的接口如下： 查询任务列表：根据DEVCLOUD_PROJECT_UUID查询任务列表。 操作步骤 查询任务列表。 接口相关信息 URI
查询任务规则集的检查参数v2 功能介绍 查询任务规则集的检查参数v2 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters 表1 路径参数 参数
查询任务检查失败日志 功能介绍 查询任务检查失败日志，不传execute_id则查询最近一次的检查日志 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/log-detail 表1 路径参数 参数 是否必选 参数类型
查询任务规则集的检查参数v3 功能介绍 查询任务规则集的检查参数v3 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters 表1 路径参数 参数
查询cmetrics缺陷概要 功能介绍 根据检查任务ID查询cmetrics缺陷概要。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/metrics-summary 表1 路径参数 参数 是否必选 参数类型 描述
修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下： 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下： 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
