检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
附录 状态码 错误码 获取项目ID 获取账号ID
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
配置代码检查任务规则集 配置代码检查任务预置规则集 配置代码检查任务自定义规则集 父主题: 配置代码检查任务
代码检查服务入门实践 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。
基本概念 表1 代码检查服务基本概念 词汇 定义 重复率 重复行数是指涉及至少一次重复的代码行数;重复块是指包含重复行的代码块(最小重复块定义:Java语言连续10行重复,其它语言10行中连续100个字符重复算一个重复块);重复率=重复行/代码总行数(不包含空行与注释)。 规则
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
停止计费 代码检查服务采用包年/包月计费模式,购买时进行一次性付费,订单到期后服务将会自动停止使用。 如果在计费周期内不再使用代码检查服务,您可以执行退订服务,代码检查服务套餐、资源扩展包均支持退订。系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到
什么是代码检查 代码检查(CodeArts Check)是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上,为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷闭环处理问题,帮助企业有效管控代码质量,助力企业成功。
使用前必读 欢迎使用代码检查服务(CodeArts Check)。代码检查是基于云端实现代码质量管理的服务,软件开发者可在编码完成后执行多语言的代码静态检查和安全检查,获取全面的质量报告,并提供缺陷的分组查看与改进建议,有效管控代码质量,帮助产品成功。 您可以使用本文档提供API
认证证书 合规证书 华为云服务及平台通过了多项国内外权威机构(ISO/SOC/PCI等)的安全合规认证,用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书
计费概述 通过阅读本文,您可以快速了解代码检查(CodeArts Check)服务的计费模式、计费项、续费、欠费等主要计费信息。 计费模式 代码检查服务采用包年/包月计费模式。包年/包月是一种预付费模式,即先付费再使用,按照订单的购买周期进行结算,因此在购买之前,您必须确保账户余额充足。
自动续费 自动续费可以减少手动续费的管理成本,避免因忘记手动续费而导致代码检查服务资源被自动删除。自动续费的规则如下所述: 以订单的到期日计算第一次自动续费日期和计费周期。 订单自动续费周期以您选择的续费时长为准。例如,您选择了3个月,订单即在每次到期前自动续费3个月。 在订单到
手动续费 在云服务控制台续费 登录管理控制台。 单击左侧导航栏的图标,选择“开发与运维 > 代码检查 CodeArts Check”。 在页面订单列表中,单击待续费订单右上角“续费”。 进入“续费”页面,根据续费时长,判断是否勾选“统一到期日”,将资源到期时间统一到各个月的某一天
使用自定义规则检查CodeArts Repo代码仓中的代码质量 应用场景 随着现在项目的代码量越来越大,以及现有开发框架的增加,静态分析所需要覆盖的场景也日益增多,存在的问题如下: 传统静态分析引擎靠工具提供通用规则来对常见安全,风格和质量场景下的编码问题进行扫描分析,难以实时覆盖不同用户特定场景下的代码问题。
创建代码检查任务 代码检查服务可检查不同代码仓的代码质量,在创建代码检查任务前,需满足以下条件: 已新建CodeArts项目。 如果使用的是代码托管服务(CodeArts Repo)的代码仓库,则可以参考代码托管服务的“用户指南 > 新建Repo代码仓库”,完成新建代码仓库。 如