检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
附录 状态码 错误码 获取项目ID 获取账号ID
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
计费模式 计费模式概述 包年/包月 资源扩展包
计费FAQ 旧版代码检查计费方式如何收费? 旧版本开通/关闭按需计费方式说明 已开通旧版代码检查服务,能否转换为新版本计费?
API 任务管理 缺陷管理 规则管理
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
图解CodeArts Check
技术类问题 执行代码检查任务时提示:任务正在执行,稍后重试 执行代码检查任务时提示:权限不足,请核对后再试 执行代码检查任务时提示:单个任务并发数超过套餐限制,任务无法下发 执行代码检查任务时提示:Cppcheck cannot tokenize the code correctly
检查任务名称 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为1~128。 规则集名称 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为1~128。 规则名称 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为1~128。 规格与限制
提供9000条以上典型检查规则。 提供多维度质量统计报表,如质量门禁和代码健康度徽标等。 精准 精确定位缺陷,提供修复指导。 支持用户自定义检查规则集,精准检查用户关注缺陷。 全面 支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTM
码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头 响应消息体 响应
示例1:查询任务列表 场景描述 本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 约束限制 无。 涉及接口 涉及的接口如下: 查询任务列表:根据DEVCLOUD_PROJECT_UUID查询任务列表。 操作步骤 查询任务列表。 接口相关信息 URI格式:GET
计费模式概述 代码检查服务采用包年/包月计费模式,提供资源扩展。 包年/包月是一种先付费再使用的计费模式,适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式,您可以预先购买代码检查服务。本文将介绍包年/包月代码检查服务的计费规则。 父主题: 计费模式
示例2:查询缺陷概要 场景描述 本章节指导用户根据检查任务ID查询缺陷结果的概要,包括问题概述、问题状态、圈复杂度、代码重复率等。 约束限制 任务存在。 涉及接口 涉及的接口如下: 查询缺陷概要:查询缺陷概要,包括问题概述、问题状态、圈复杂度、代码重复率等。 操作步骤 接口相关信息
梳理各类场景需要,内置全面检查规则集、关键检查规则集、移动领域规则集、华为编程规范规则集等50+规则集,便于用户开箱即用。更多规则集详情,请参见代码检查规则集列表。 用户也可基于规则库定制满足场景专项需求的检查规则集 。 父主题: 产品特性