检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
附录 状态码 错误码 获取项目ID 获取账号ID
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
检查任务名称 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为1~128。 规则集名称 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为1~128。 规则名称 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为1~128。 规格与限制
规则集语言 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 400 表3 响应Body参数 参数
执行代码检查任务时提示:权限不足,请核对后再试 问题现象 执行任务失败,提示异常信息:权限不足,请核对后再试。 原因分析 当前用户操作权限不足,无法操作该任务,请用户根据权限矩阵,核对并联系项目管理员(项目创建者、项目经理)更改当前账号权限。 处理方法 进入项目“成员管理”页面,查看自己的项目角色权限。
已经将组件上传到私有依赖库,但用户账号没有此私有依赖库的授权,导致从私有依赖库中下载组件失败。 处理方法 将组件上传到私有依赖库。 使用拥有私有依赖仓库管理员权限的账号进入私有依赖库的“独立用户权限”页面为用户账号分配此私有依赖库角色(开发者)来进行授权。 操作方法请参见:管理用户权限。 父主题:
描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型
代码检查服务入门实践 当用户开通代码检查服务后,可以根据不同的业务场景灵活使用。 本文介绍常见的代码检查实践。 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。
账单管理”查看资源的费用账单。 账单上报周期 购买代码检查服务套餐、资源扩展完成支付后,会实时上报一条账单到计费系统进行结算。 查看指定订单账单 登录管理控制台。 在页面上方选择“费用 > 费用账单”,进入“账单概览”页面。 选择“流水和明细账单”,选择账期,设置筛选条件(产品类型“代码检查
在云服务控制台开通自动续费 登录管理控制台。 单击左侧导航栏的图标,选择“开发与运维 > 代码检查 CodeArts Check”。 找到已购买的代码检查服务套餐记录,单击“自动续费”旁边“设置”。 选择续费时长,并根据需要设置自动续费次数,单击“确认”。 在续费管理页面开通自动续费 登录管理控制台。
码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头 响应消息体 响应
户的安全责任在于对使用的IaaS、PaaS和SaaS类云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮
示例1:查询任务列表 场景描述 本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 约束限制 无。 涉及接口 涉及的接口如下: 查询任务列表:根据DEVCLOUD_PROJECT_UUID查询任务列表。 操作步骤 查询任务列表。 接口相关信息 URI格式:GET
示例2:查询缺陷概要 场景描述 本章节指导用户根据检查任务ID查询缺陷结果的概要,包括问题概述、问题状态、圈复杂度、代码重复率等。 约束限制 任务存在。 涉及接口 涉及的接口如下: 查询缺陷概要:查询缺陷概要,包括问题概述、问题状态、圈复杂度、代码重复率等。 操作步骤 接口相关信息
梳理各类场景需要,内置全面检查规则集、关键检查规则集、移动领域规则集、华为编程规范规则集等50+规则集,便于用户开箱即用。更多规则集详情,请参见代码检查规则集列表。 用户也可基于规则库定制满足场景专项需求的检查规则集 。 父主题: 产品特性