检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 任务管理 缺陷管理 规则管理
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
图解CodeArts Check
安全 责任共担 身份认证与访问控制 数据保护技术 审计与日志 服务韧性 认证证书
续费 续费概述 手动续费 自动续费
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
配置代码检查任务规则集 配置代码检查任务预置规则集 配置代码检查任务自定义规则集 父主题: 配置代码检查任务
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题。 错误响应Body体格式说明
执行代码检查任务 用户可以对目标代码检查任务执行检查,及时发现源代码中的代码问题。 执行代码检查有两种方式: 手动执行:创建完代码检查任务后手动执行代码检查任务。本章节介绍的为手动执行代码检查任务的操作指导。 定时执行:多用于日常执行代码检查,配置详情可参考配置代码检查任务定时执行。
项目级和任务级支持事件通知设置。 本节以任务级门禁设置为例介绍操作步骤。 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。 进入“代码检查详情”页面,选择“设置 > 质量门禁”。 在“质量门禁”区域,根据质量要求开启门禁开关,并设置门禁阈值。 图1
-广州,华南-深圳,西南-贵阳一 创建代码检查任务 执行代码检查任务 查看代码检查详情 计费说明 代码检查是软件开发生产线CodeArts中的一个服务,可单独购买使用,也可以开通CodeArts基础版或购买CodeArts专业版即可使用代码检查服务。 支持区域: 华北-北京一,华
代码检查提供的资源扩展包为并发扩展,采用包年/包月,可增加检查任务并发执行数。 代码检查并发扩展 表1 代码检查并发扩展 计费方式 包年/包月 适用场景 当代码检查服务套餐中包含的代码检查任务并发数不满足实际使用需求时,可购买代码检查并发扩展。 计费项 并发数。 购买限制 购买代码检查并发扩展前,须完成代码检查服务基础版及以上规格套餐的购买。
Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调