检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
任务创建 创建检查任务 规则集设置 配置代码检查规则集 自定义代码检查规则集 任务设置 任务设置 任务执行 执行代码检查任务 查看代码检查详情 02 入门 从0到1,快速学习代码检查服务。
购买CodeArts Check 前提条件 已注册华为云并实名认证,如果还没有华为账号,请参考以下步骤创建。 打开华为云网站。 单击“注册”,根据提示信息完成注册。 注册成功后,系统会自动跳转至您的个人信息界面。 参考实名认证完成个人或企业账号实名认证。
支持快速筛选已识别的编程规范问题,支持规范、标准的知识联动,便于用户快速了解问题类别、严重性、详情,从而根据自身项目需要,快速分析和制定修复计划。
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
创建Repo代码源检查任务 在代码托管中创建云端仓库时,若勾选了“自动创建代码检查任务”,则代码仓库创建完成后,在代码检查任务列表可查看对应仓库的检查任务。 以下示例为在代码托管服务中创建云端仓库不勾选“自动创建代码检查任务”时,Repo代码源代码检查任务的创建步骤。
创建自定义规则集 功能介绍 可根据需求灵活的组合规则。 调用方法 请参见如何调用API。
表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。
本示例为您演示检查CodeArts Repo代码仓库中的代码质量,帮助您快速建立对代码检查服务的整体印象。 前提条件 已注册华为云并实名认证,如果还没有华为账号,请参考以下步骤创建。 打开华为云网站。 单击“注册”,根据提示信息完成注册。
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
不支持 支持 跨站脚本攻击(XSS) 支持 支持 攻击者利用在网站、电子邮件中的链接插入恶意代码,盗取用户信息。 不支持 支持 LDAP注入 支持 支持 利用用户输入的参数生成非法LDAP查询,盗取用户信息。
规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
计费模式 计费模式概述 包年/包月 资源扩展包
服务开通后,需注意创建的资源也分区域。 例如,在“华北-北京四”中创建了“项目A”,在下次查看“项目A”时,需先切换到“项目A”所在区域“华北-北京四”。 代码检查服务为免费使用。 开通服务前可以免费体验,即提供10万行代码免费额度。 开通服务后可以免费使用。
如何调用API 构造请求 认证鉴权 返回结果
开展实践前,需要完成创建项目和创建仓库。 预置任务简介 样例项目中预置了以下4个代码检查任务。 表1 预置任务 预置任务 任务说明 phoenix-codecheck-worker 检查Worker功能对应代码的任务。
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
续费 续费概述 手动续费 自动续费
执行代码检查有两种方式: 手动执行:创建完代码检查任务后手动执行代码检查任务。本章节介绍的为手动执行代码检查任务的操作指导。 定时执行:多用于日常执行代码检查,配置详情可参考配置代码检查任务定时执行。 前提条件 已创建代码检查任务。