检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
附录 状态码 错误码 获取项目ID 获取账号ID
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
表1 代码检查服务默认角色权限 资源权限/角色 项目管理员 项目经理 开发人员 测试经理 测试人员 参与者 浏览者 运维经理 产品经理 系统工程师 Committer 检查任务 创建 √ √ √ × × × × × × √ √ 执行 √ √ √ × × × × × √ √ √ 查看
代码检查服务订单在到期前可开通自动续费,到期前7日凌晨3:00首次尝试自动续费,如果扣款失败,每天凌晨3:00尝试一次,直至订单到期或者续费成功。到期前7日自动续费扣款是系统默认配置,您也可以根据需要修改此扣款日。 父主题: 续费
08 15:50:04 ~ 2023/04/08 23:59:59。 变更配置 代码检查并发扩展支持变更并发数,可增加或减少并发数。变更时系统将按照如下规则为您计算变更费用。 资源升配:变更后的并发数高于变更前,此时您需要支付新老配置的差价。 资源降配:变更后的并发数低于变更前,此时华为云会将新老配置的差价退给您。
当前代码检查服务套餐不满足您的业务需要时,您可以在代码检查控制台发起变更操作。 变更操作可选择“即时变更”或“续费变更”。 即时变更:变更操作在当前的套餐周期内生效,变更时系统将按照如下规则为您计算变更费用。 资源升配:变更后的套餐价格高于变更前价格,此时您需要支付新老配置的差价。 资源降配:变更后的套餐价格低于
目都有1个唯一的项目ID 表2 Query参数 参数 是否必选 参数类型 描述 category 否 String 规则集类别 '0只查询系统规则集,1只查询当前用户自定义规则集,2只查询其他用户自定义规则集,'0,1,2'或''查所有' offset 否 Integer 分页索引,偏移量
项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID 表2 Query参数 参数 是否必选 参数类型 描述 category 否 String 规则集类别 0只查询系统规则集;1只查询当前用户自定义规则集;2只查询其他用户自定义规则集;0,1,2或空查所有 offset 否 Integer 分页索引,偏移量
前提条件 已注册华为云并实名认证,如果还没有华为账号,请参考以下步骤创建。 打开华为云网站。 单击“注册”,根据提示信息完成注册。 注册成功后,系统会自动跳转至您的个人信息界面。 参考实名认证完成个人或企业账号实名认证。 已开通CodeArts体验版套餐,如果还没有开通,可参考购买CodeArts套餐。
什么是代码检查 代码检查(CodeArts Check)是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上,为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷闭环处理问题,帮助企业有效管控代码质量,助力企业成功。
在代码检查任务中,选择“概览”页签,即可查看任务执行结果统计。 单击“代码问题”页签,即可看到问题列表。 单击问题框中的“问题帮助”,可以查看系统对此问题的修改建议。可以根据需要在代码仓库中找到对应文件及代码位置,参考修改建议优化代码。
String 规则集状态optional:可选,selected:已选 status String 规则集属性0 是默认用户规则集,1 是系统默认规则集 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
String 规则集状态optional:可选,selected:已选 status String 规则集属性0 是默认用户规则集,1 是系统默认规则集 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
用的规则集将在下一次执行检查时生效。 代码检查服务支持多种语言的规则集,且每种语言类型对应多种不同级别的规则集,系统规则集列表请参见表1。 表1 预置规则集 语言 系统规则集类型 默认规则集 支持扫描文件后缀 扩展参数支持的编译工具版本 检查引擎 C++ 华为C编程规则集 华为C增强编程规则集
认证证书 合规证书 华为云服务及平台通过了多项国内外权威机构(ISO/SOC/PCI等)的安全合规认证,用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书
计费概述 通过阅读本文,您可以快速了解代码检查(CodeArts Check)服务的计费模式、计费项、续费、欠费等主要计费信息。 计费模式 代码检查服务采用包年/包月计费模式。包年/包月是一种预付费模式,即先付费再使用,按照订单的购买周期进行结算,因此在购买之前,您必须确保账户余额充足。