检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
查询任务执行状态 功能介绍 根据任务ID查询任务执行状态。任务状态:0表示检查中,1表示检查失败,2表示检查成功,3表示任务中止。只有正在检查中才有进度的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/progress 表1 路径参数
"name": "xxxxxxxx" } } } } 获取Token后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,
Check代码检查插件(IntelliJ IDEA版本) 华为云CodeArts Check代码检查插件(CodeArts IDE本地版本) 介绍视频 父主题: 产品特性
任务执行完成后没有数据 问题现象 任务执行检查完毕后没有数据。 原因分析 源代码仓语言没有获取到。 检查语言开关没有打开。 处理方法 进入任务“设置 > 规则集”页面。 单击“已包含语言”所在行重新获取代码仓语言。 打开需要检查语言的开关。 重新执行检查。 父主题: 技术类问题
执行代码检查任务时提示:权限不足,请核对后再试 问题现象 执行任务失败,提示异常信息:权限不足,请核对后再试。 原因分析 当前用户操作权限不足,无法操作该任务,请用户根据权限矩阵,核对并联系项目管理员(项目创建者、项目经理)更改当前账号权限。 处理方法 进入项目“成员管理”页面,查看自己的项目角色权限。
使用自定义规则扫描10万行代码行最多时长1.5小时。仅适用于使用的规则集中只包含自定义规则。 te_admin账号规则创建者可以编辑和删除自定义规则。 操作视频 本视频为您演示使用自定义规则集检查Repo代码仓中代码质量的操作。 创建自定义检查规则集 基于项目入口访问CodeArts Check服务首页。
了解更多常见问题、案例和解决方案 热门案例 执行代码检查任务时提示:no such file or directory 任务执行完成后没有数据 更多 技术类问题 执行代码检查任务时提示:任务正在执行,稍后重试 更多 API类问题 使用公共API时提示没有权限 更多 智能客服 您好!我是有问必答知识渊博的智能问答机器人,有问题欢迎随时求助哦!
try again after the check is successful 当前任务尚未检查或检查成功过,请检查或检查成功后重试 请检查或检查成功后重试 父主题: 附录
在“忽略的文件集合”区域,勾选无需进行检查的文件路径。设置完成后,执行代码检查任务,将按照设置排除选中的文件路径执行检查。 勾选的忽略文件对需要编译的文件和不需要编译的文件均生效。 不需要编译的文件:勾选忽略文件后,被忽略的文件不参与检查。 需要编译的文件:例如A文件与B文件互
Check通过调用API执行MR增量检查 应用场景 在用户实际的使用场景中,用户往往有构建自己的代码质量管控平台,集成代码检查及其他检查项的需求。并且在用户的应用场景中,MR合入过程中的质量监控是一个高频应用场景。 本示例介绍如何通过调用CodeArtsCheck API方式,执行MR增量代码检查并获取检查结果。通过调用CodeArtsCheck
前提条件 已注册华为云并实名认证,如果还没有华为账号,请参考以下步骤创建。 打开华为云网站。 单击“注册”,根据提示信息完成注册。 注册成功后,系统会自动跳转至您的个人信息界面。 参考实名认证完成个人或企业账号实名认证。 购买CodeArts Check须知 在CodeArts支持
代码检查服务入门实践 当用户开通代码检查服务后,可以根据不同的业务场景灵活使用。 本文介绍常见的代码检查实践。 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。
费用账单 您可以在“费用中心 > 账单管理”查看资源的费用账单。 账单上报周期 购买代码检查服务套餐、资源扩展完成支付后,会实时上报一条账单到计费系统进行结算。 查看指定订单账单 登录管理控制台。 在页面上方选择“费用 > 费用账单”,进入“账单概览”页面。 选择“流水和明细账单
变更代码检查服务规格 变更代码检查服务套餐规格 代码检查服务支持变更套餐规格,变更影响请参见变更配置后对计费的影响。 登录代码检查控制台。 找到代码检查服务套餐,单击“变更”。 根据需要选择变更规格、变更类型,勾选同意声明,单击“下一步”。 若变更类型选择“续费变更”,则还需要选择续费时长。
利用当前规则集扫描,显示问题较多。 处理建议 检查结果中展现了TOP10问题规则名称及其数量。您可根据任务的具体情况去除问题数较多的规则,使总问题数量降至30W以下后再次进行扫描。 父主题: 技术类问题