检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在工具版本升级后,由于代码检查服务检查引擎的能力提升,可能会出现新的缺陷。但新检查出来的缺陷,不会计算到正式缺陷中,开发者拥有60天的缓冲周期对代码进行修改,周期内没有修改或者屏蔽的缺陷,在周期结束后后会计算到正式缺陷中。 执行计划 定义代码检查任务自动触发的方式。通过触发器,使代码检查的自动化执行更加灵活易用。
续费 续费概述 手动续费 自动续费
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志 获取任务的目录树 任务配置屏蔽目录 查询任务的高级配置 任务配置高级配置 查询分支任务列表
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
行扫描)大规模持续使用和打磨而成。 覆盖了业界主流开发语言,针对代码的可读、可维护、安全、可靠、可测试、高效、可移植等方面进行全面的分析。 融合了多年对代码质量及可信度提升方面持续思考与探索、实践,积累了丰富的检查规则。 父主题: 产品特性
”页面。 输入该访问密钥的描述信息。 单击“确定”,下载访问密钥。 为防止访问密钥泄露,建议您将其保存到安全的位置。 下载KooCLI工具并获取代码检查API的调用命令 访问华为云命令行工具服务KooCLI文档页面。 根据本地电脑的系统版本号下载对应版本的KooCLI工具。 访问代码检查API调试页面。
"fxxxxxsz" #服务扩展点ID } 新建全量任务的返回结果。响应值为全量任务的任务ID,即创建增量任务需要用到的“parent_task_id”。 创建全量任务后,可在华为云对应局点账号下的项目中,查看到新建的代码检查任务。 新建MR增量代码检查任务的请求示例。 CreateTask:/v2/{project_id}/task
调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题。 错误响应Body体格式说明
配置CodeArts Check项目级角色权限 新增的成员需赋予指定的角色,不同角色具备的默认权限不同。各角色具备的默认权限如表1。 表1 代码检查服务默认角色权限 资源权限/角色 项目管理员 项目经理 开发人员 测试经理 测试人员 参与者 浏览者 运维经理 产品经理 系统工程师
数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-1
购买代码检查并发扩展前,须完成代码检查服务基础版及以上规格套餐的购买。 代码检查并发扩展的购买上限为100并发。 计费公式 单价*并发数*购买时长。 计费周期 根据购买时长确定(以GMT+08:00时间为准)。一个计费周期的起点是您开通或续费代码检查并发扩展的时间(精确到秒),终点则是到期日的23:59:59。 例如,您在2023/03/08
想继续使用,需要在指定的时间内为代码检查服务续费。 代码检查服务在到期前续费成功,代码检查服务可正常使用,且代码检查任务的运行不受影响。代码检查服务到期后的状态说明,请参见到期后影响。 续费相关的功能 代码检查服务续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明 手动续费
用户往往不熟悉工具提供的通用规则所能覆盖的全部场景。在为新开发的业务场景寻找适用的规则时需要耗费大量的时间,增加开发成本。 不同用户之间的代码差异大,研发无法实时掌握不同用户的具体需求,在开发规则过程中难以针对不同用户的业务代码场景来制定全面有效的工具规则。 本示例为您介绍如何使用自定义规则检查代码中存在调试代码的问题。
任务设置 API 代码检查 CodeArts Check(原CodeCheck)是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量,助力企业成功。 支持区域: 华北-北京一,华北-北京
智能群助手”,然后添加机器人(选择自定义类型)。 填写机器人名字,选择群组,完成安全设置(需勾选“加签”,并单击加签文本框旁的“复制”获取加签密钥)。 已阅读并同意相关协议后,单击“完成”。 单击Webhook文本框旁的“复制”,获取钉钉Webhook地址。 将“钉钉通知”开关设置为状态。
代码检查服务可检查不同代码仓的代码质量,在创建代码检查任务前,需满足以下条件: 已新建CodeArts项目。 如果使用的是代码托管服务(CodeArts Repo)的代码仓库,则可以参考代码托管服务的“用户指南 > 新建Repo代码仓库”,完成新建代码仓库。 如果使用的是第三方代码仓库,需已创建可用的代码仓库。