检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置代码检查任务质量门禁 根据质量要求设置门禁阈值,即可了解您的项目是否已准备好投入生产。例如,实际的检查结果超出设置的门禁阈值,则表示当前项目还不具备生产条件。 门禁质量设置支持租户级、项目级以及任务级,优先级为租户级 > 项目级 > 任务级。入口分别如下: 租户级:进入代码检查服务首页
包年/包月 包年/包月套餐说明 代码检查服务采用包年/包月、并发扩展计费模式,提供基础版、专业版套餐,以满足不同规模用户的使用需求。并支持安全增强能力、并发扩展能力叠加。 不同版本套餐中,提供的功能特性及资源规格略有不同,详情请参见表1。 代码检查资源扩展包:在CodeArts或CodeArts
续费概述 续费简介 包年/包月服务到期后会影响代码检查服务正常运行。如果您想继续使用,需要在指定的时间内为代码检查服务续费。 代码检查服务在到期前续费成功,代码检查服务可正常使用,且代码检查任务的运行不受影响。代码检查服务到期后的状态说明,请参见到期后影响。 续费相关的功能 代码检查服务续费相关的功能如表
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
查询任务的高级配置 功能介绍 查询任务的高级配置 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
历史扫描结果查询 功能介绍 提供每次扫描的问题数量统计 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/checkrecord 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询任务规则集的检查参数v2 功能介绍 查询任务规则集的检查参数v2 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters 表1 路径参数 参数
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
查询缺陷详情的统计 功能介绍 根据检查任务ID查询缺陷详情的统计 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-statistic 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID
查询任务检查失败日志 功能介绍 查询任务检查失败日志,不传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 路径参数 参数
使用预置规则检查通用Git代码仓中的代码质量 应用场景 如果您的代码存放在通用Git代码仓中,可参考本实践的操作指导完成检查代码质量。本实践为您介绍如何使用系统预置规则检查通用Git代码仓中的Java语言代码质量。 前提准备 已开通并授权使用代码检查服务授权使用代码检查服务。 通用
修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下: 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下: 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置
HE2E DevOps实践:代码检查 本文以“DevOps全流程示例项目”为例,介绍如何在项目中进完成代码检查配置。 开展实践前,需要完成创建项目和创建仓库。 预置任务简介 样例项目中预置了以下4个代码检查任务。 表1 预置任务 预置任务 任务说明 phoenix-codecheck-worker
什么是代码检查 代码检查(CodeArts Check)是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上,为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷闭环处理问题,帮助企业有效管控代码质量,助力企业成功
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值
审计与日志 审计 云审计服务(Cloud Trace Service,CTS),是华为云安全解决方案中专业的日志审计服务,提供对各种云资源操作记录的收集、存储和查询功能,可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务并创建和配置追踪器后,CTS
CodeArts Check通过调用API执行MR增量检查 应用场景 在用户实际的使用场景中,用户往往有构建自己的代码质量管控平台,集成代码检查及其他检查项的需求。并且在用户的应用场景中,MR合入过程中的质量监控是一个高频应用场景。 本示例介绍如何通过调用CodeArtsCheck
创建代码检查任务 代码检查服务可检查不同代码仓的代码质量,在创建代码检查任务前,需满足以下条件: 已新建CodeArts项目。 如果使用的是代码托管服务(CodeArts Repo)的代码仓库,则可以参考代码托管服务的“用户指南 > 新建Repo代码仓库”,完成新建代码仓库。 如果使用的是第三方代码仓库