检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
附录 状态码 错误码 获取项目ID 获取账号ID
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
续费概述 续费简介 包年/包月服务到期后会影响代码检查服务正常运行。如果您想继续使用,需要在指定的时间内为代码检查服务续费。 代码检查服务在到期前续费成功,代码检查服务可正常使用,且代码检查任务的运行不受影响。代码检查服务到期后的状态说明,请参见到期后影响。 续费相关的功能 代码检查服务续费相关的功能如表1所示。
永久移动,请求的资源已被永久的移动到新的URI,返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改,服务器返回此状态码时,不会返回任何资源。 305 Use
选中的规则集使用了secbrella检查引擎时,必须要设置“检查参数”并开启配置开关,代码检查扩展参数请根据实际情况进行配置。 选中的规则集使用了oat检查引擎时,必须要设置“检查参数”并开启配置开关(默认已开启)。其中仓库地址为oat工具-n参数,用于匹配默认策略,可以使用默认值或
配置代码检查任务定时执行 根据实际需要,设置代码检查任务的执行计划,定时执行默认分支的检查任务。 建议在非流水线使用情况下进行配置。 配置当天时间间隔必须在5分钟以上。 配置执行计划 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。
删除自定义规则集 功能介绍 删除自定义规则集,正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
计费模式概述 代码检查服务采用包年/包月计费模式,提供资源扩展。 包年/包月是一种先付费再使用的计费模式,适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式,您可以预先购买代码检查服务。本文将介绍包年/包月代码检查服务的计费规则。 父主题: 计费模式
Token认证:通过Token认证调用请求,访问代码检查用户界面默认使用Token认证机制。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。 关于认证鉴权的详细介绍及获取方式,请参见认证鉴权。
应用场景 Web应用安全检查 应用:使用规则集对Web开发语言进行代码检视,并为开发角色提供修复建议,比如修改的代码位置、系统、语言、模块、引擎等。 场景特点:Web服务面向Internet互联网,容易遭受DDos攻击、信息泄露等风险。 适用场景:互联网服务交付安全等级验收。 项目质量控制
软件产品的质量问题往往导致产品产生不可接受的运营风险或过度成本,因此在源代码级别建立质量检测措施的标准是非常重要的,业界如ISO/IEC 5055标准、CERT编程规范等。 使用代码检查服务,可以对您的代码进行全面的质量检查。 支持快速筛选已识别的编程规范问题,支持规范、标准的知识联动,便于用户快速了解问题类别、严
包年/包月 包年/包月套餐说明 代码检查服务采用包年/包月、并发扩展计费模式,提供基础版、专业版套餐,以满足不同规模用户的使用需求。并支持安全增强能力、并发扩展能力叠加。 不同版本套餐中,提供的功能特性及资源规格略有不同,详情请参见表1。 代码检查资源扩展包:在CodeArts或CodeArts
即先付费再使用,按照订单的购买周期进行结算,因此在购买之前,您必须确保账户余额充足。 计费项 代码检查资源扩展计费项为代码检查任务并发数,了解计费项的计费因子、计费公式等信息,请参见计费项。 续费 包年/包月订单在到期后会影响代码检查服务正常使用。如果您想继续使用代码检查服务,
代码检查引擎团队凝聚了国内40+博士、海外研究所50+专家、国内外10+老师合作成果,经过华为内部(15W+开发人员,日均500亿行扫描)大规模持续使用和打磨而成。 覆盖了业界主流开发语言,针对代码的可读、可维护、安全、可靠、可测试、高效、可移植等方面进行全面的分析。 融合了多年对代码质量
已开通CodeArts体验版套餐,如果还没有开通,可参考购买CodeArts套餐。 准备Repo代码仓 使用华为云账号登录华为云控制台页面。 单击页面左上角,在服务列表中选择“开发与运维 > 软件开发生产线 CodeArts”。 单击“立即使用”,进入软件开发生产线服务首页。 单击“新建项目”,选用“Scrum”
Check最佳实践一览表 最佳实践 说明 使用预置规则检查GitCode代码仓中的代码质量 如果您的代码存放在GitCode代码仓中,可参考本实践的操作指导完成检查代码质量。本实践为您介绍如何使用系统预置规则检查GitCode代码仓中的Java语言代码质量。 使用预置规则检查通用Git代码仓中的代码质量
需先切换到“项目A”所在区域“华北-北京四”。 代码检查服务为免费使用。 开通服务前可以免费体验,即提供10万行代码免费额度。 开通服务后可以免费使用。 当使用量超出免费额度(10万行)时,系统会提示开通按需使用或购买套餐。请根据实际需要开通代码检查服务。 父主题: 计费FAQ