检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
续费 续费概述 手动续费 自动续费
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
您也可以通过这个视频教程了解AK/SK认证的使用:https://bbs.huaweicloud.com/videos/100697 。 父主题: 如何调用API
代码检查插件(Cloud IDE版本) 华为云CodeArts Check代码检查插件(VSCode IDE版本) 华为云CodeArts Check代码检查插件(IntelliJ IDEA版本) 华为云CodeArts Check代码检查插件(CodeArts IDE本地版本) 介绍视频
内置多款的开源工具与自研引擎一起提供丰富的检查规则(9000+)。 梳理各类场景需要,内置全面检查规则集、关键检查规则集、移动领域规则集、华为编程规范规则集等50+规则集,便于用户开箱即用。更多规则集详情,请参见代码检查规则集列表。
您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987 。 请求URI 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。
配置代码检查任务自定义环境 当使用代码检查服务时,若常用的编译构建环境缺少您需要的依赖包、工具,无法满足您的使用需求时,您可通过自定义构建环境提供的基础镜像执行代码检查任务。 前提条件 已将自定义环境推送到镜像仓中,具体操作请参见制作镜像并推送到SWR仓库。
用户往往不熟悉工具提供的通用规则所能覆盖的全部场景。在为新开发的业务场景寻找适用的规则时需要耗费大量的时间,增加开发成本。 不同用户之间的代码差异大,研发无法实时掌握不同用户的具体需求,在开发规则过程中难以针对不同用户的业务代码场景来制定全面有效的工具规则。
或将本地准备好的xlsx格式的规则文件导入至工具。 父主题: 参考
场景特点:项目经理的共识“从前端保证质量,把质量做在日常交付”,但经常没有有效的工具平台,目前大部分的质量工作还是依赖后端测试。 适用场景:项目经理迭代交付质量控制。
其中仓库地址为oat工具-n参数,用于匹配默认策略,可以使用默认值或根据实际情况进行配置。详见oat开源项目。 父主题: 配置代码检查任务规则集
表5 TaskCheckParamters 参数 参数类型 描述 check_id Integer 检查工具ID name String 编译参数名称 checker_configs Array of CheckConfigInfo objects 检查参数配置信息 表6 CheckConfigInfo
表4 响应Body参数 参数 参数类型 描述 data Array of TaskCheckParamters objects 历史记录数据 total Integer 总数 表5 TaskCheckParamters 参数 参数类型 描述 check_id Integer 检查工具
Content-Type 是 String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型 描述 check_id 是 Integer 检查工具ID,参数已废弃 ruleset_id 是 String 规则集ID,可以通过查询任务的已选规则集列表接口获取
String 规则状态0:未启用,1:已启用 rule_config_list Array of RuleConfig objects 规则配置参数阈值相关信息 表6 RuleConfig 参数 参数类型 描述 id Integer 规则配置ID rule_id String 工具规则