# 代码检查 CodeArts Check > 基于云端实现代码质量管理的服务 ## 服务公告 - [【告警变更】C/C++ 检查引擎规则告警问题级别更新,按照MISRA AUTOSAR修改等级。](https://support.huaweicloud.com/bulletin-codecheck/codecheck_bu_0001.md): C/C++ 检查引擎规则告警问题级别更新,按照MISRA AUTOSAR修改等级。 ## 产品介绍 - [图解CodeArts Check](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1000.md): - [什么是代码检查](https://support.huaweicloud.com/productdesc-codecheck/devcloud_pdtd_30001.md): 代码检查(CodeArts Check)是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上,为用户提供代码风格、通用质量与网络安全等方面的检查能力,专业的扫描报告、便捷的问题闭环处理流程,帮助企业有效管控代码质量,助力企业成功。产品形态包括:云服务和IDE插件。同时,还提供具有深度检查能力的代码 - [自研代码检查引擎](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1003.md): 代码检查服务的核心就是代码检查引擎,高效精准的代码检查引擎能够很好地帮助用户在开发早期快速、准确地发现代码问题,兼顾开发效率与产品质量。代码检查引擎团队凝聚了国内40+博士、海外研究所50+专家、国内外10+老师合作成果,经过华为内部(15W+开发人员,日均500亿行扫描)大规模持续使用和打磨而成。覆盖了业界主流开发语言,针对代码的可读、 - [支持五大业界主流标准和华为编程规范](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1004.md): 软件产品的质量问题往往导致产品产生不可接受的运营风险或过度成本,因此在源代码级别建立质量检测措施的标准是非常重要的,业界如ISO/IEC 5055标准、CERT编程规范等。使用代码检查服务,可以对您的代码进行全面的质量检查。支持快速筛选已识别的编程规范问题,支持规范、标准的知识联动,便于用户快速了解问题类别、严重性、详情,从而根据自身项目 - [支持主流开发语言](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1005.md): 代码检查服务支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTML/PHP/LUA/RUST/Shell/KOTLIN/SCALA/ArkTS/SQL/仓颉(Cangjie) 等10+常见开发语言,满足嵌入式、WEB应用、移动应用等多种开发场景所需。内置多款的开源工具与自研引擎一起提供 - [日均百亿级扫描能力](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1006.md): 代码检查具备强大的高并发处理能力,在华为内部,日常15万+软件开发人员高频代码提交增量检查,每日凌晨所有代码仓定时检查,服务日均扫描百亿行级代码。服务通过AZ容灾、跨region级容灾多活、支持过载保护、服务依赖和隔离等一系列高可用特性,实现服务故障自探测、自隔离、自恢复,为大型应用和团队提供可靠支持。针对检查业务峰谷明显的业务特征,通过 - [一站式问题闭环修复](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1007.md): 开发团队实施代码检查活动时通常遇到问题分析和修复成本高(工具问题不易理解、问题分到具体开发人员费时费力、多版本情况下重复处理同一告警令开发人员厌倦工具)导致落地困难,这些原因很大程度影响了开发人员对检查工具的使用积极性。代码检查服务提供问题分析处理三大能力,帮助开发团队高效、顺畅使用代码检查:问题精准定位到行、提供修复指导(内置编程规范说 - [“代码编写、代码合并、版本发布”三层缺陷防护](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1008.md): 优秀的代码质量保障实践,往往将代码检查融入到开发作业流中,在用户代码编写、代码提交时进行自动化的审计检查,并对团队每日产出的代码进行持续编程规范和质量检查。这一活动实践要求已是安全开发过程SDL、DevSecOps等众多优秀开发模式推荐进行的实践要求。代码检查服务提供丰富的API接口、涵括任务新建、任务设置、任务扫描、任务报告解析等检查业 - [代码检查安全增强](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1010.md): CodeArts Check提供代码安全检查增强包的能力,其安全检查能力作为深度价值特性,能深度识别代码中安全风险和漏洞,提供了套餐包内规则不覆盖的安全类场景,比如数值错误、加密问题、数据验证问题等。针对业界的安全漏洞检测项提供了更深入的分析能力,如跨函数、跨文件、污点分析、语义分析等。当前代码安全检查增强包一共有284条规则,涵盖Jav - [灵活匹配用户场景](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1009.md): 在软件开发实践中,代码质量管控面临着多样化的现实挑战:例如,不同团队的编码规范存在差异(如特定命名规则、注释格式),复杂业务场景需要定制化逻辑校验,新兴技术框架的最佳实践需要强制落地,通用代码检查工具的内置规则往往聚焦于语法合规、空指针风险等基础问题,难以覆盖行业特性、业务逻辑或团队定制化要求。基于以上行业背景,华为云CodeArts C - [产品优势](https://support.huaweicloud.com/productdesc-codecheck/codecheck_pdtd_1000.md): 提供9000条以上典型检查规则。提供多维度质量统计报表,如质量门禁和代码健康度徽标等。精确定位缺陷,提供修复指导。支持用户自定义检查规则集,精准检查用户关注缺陷。支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTML/PHP/LUA/RUST/Shell/KOTLIN/SCALA/Ar - [应用场景](https://support.huaweicloud.com/productdesc-codecheck/codecheck_pdtd_1001.md): 应用:使用规则集对Web开发语言进行代码检视,并为开发角色提供修复建议,比如修改的代码位置、系统、语言、模块、引擎等。场景特点:Web服务面向Internet互联网,容易遭受DDos攻击、信息泄露等风险。适用场景:互联网服务交付安全等级验收。应用:在交付过程中实时根据代码复杂度、重复率、质量得分控制风险。场景特点:项目经理的共识从前端保证 - [产品功能](https://support.huaweicloud.com/productdesc-codecheck/codecheck_pdtd_1002.md): 本页面介绍了代码检查(CodeArts Check)服务支持的主要功能。关于各功能支持的地域(Region)信息,可通过控制台查询详情。CodeArts Check是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量,助力企业成功。有关更多信 - [身份认证与访问控制](https://support.huaweicloud.com/productdesc-codecheck/codecheck_07_0005.md): 用户访问代码检查服务的方式有多种,包括代码检查用户界面、API、SDK,无论访问方式封装成何种形式,其本质都是通过代码检查提供的REST风格的API接口进行请求。代码检查的接口需要经过认证请求后才可以访问成功。代码检查支持两种认证方式:Token认证:通过Token认证调用请求,访问代码检查用户界面默认使用Token认证机制。AK/SK认 - [数据保护技术](https://support.huaweicloud.com/productdesc-codecheck/codecheck_07_0006.md): 代码检查通过多种数据保护手段和特性,保障数据安全可靠。 - [审计与日志](https://support.huaweicloud.com/productdesc-codecheck/codecheck_07_0007.md): 云审计服务(Cloud Trace Service,CTS),是华为云安全解决方案中专业的日志审计服务,提供对各种云资源操作记录的收集、存储和查询功能,可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。用户开通云审计服务并创建和配置追踪器后,CTS可记录代码检查的管理事件和数据事件用于审计。CTS的详细介绍和开通配置方法,请 - [服务韧性](https://support.huaweicloud.com/productdesc-codecheck/codecheck_07_0008.md): 代码检查通过多活无状态的跨AZ部署、AZ之间数据容灾等技术方案,保证业务进程故障时快速启动并修复,以保障服务的持久性和可靠性。即在另一个可用区(跨AZ)部署一个同构的CodeArts Check灾备集群,如果生产集群所处的地理位置发生自然灾害。或者集群内部出现了故障从而导致生产集群无法正常对外提供读写服务,那么灾备集群可以切换为生产集群。 - [认证证书](https://support.huaweicloud.com/productdesc-codecheck/codecheck_07_0009.md): 华为云服务及平台通过了多项国内外权威机构(ISO/SOC/PCI等)的安全合规认证,用户可自行申请下载合规资质证书。合规证书下载华为云还提供以下资源来帮助用户满足合规性要求,具体请查看资源中心。资源中心华为云安全服务提供了网络安全专用产品安全检测证书、软件著作权等证书,供用户下载和参考。具体请查看合规资质证书。合规资质证书 - [约束与限制](https://support.huaweicloud.com/productdesc-codecheck/codecheck_07_0001.md): 不同区域购买的资源不能跨区使用,需慎重选择。如果已经购买了CodeArts套餐,则无需再单独购买CodeArts Check套餐。 - [基于IAM进行权限管理](https://support.huaweicloud.com/productdesc-codecheck/codecheck_pdtd_1003.md): 如果您需要对华为云上购买的代码检查(CodeArts Check)资源,为企业中的员工设置不同的访问权限,以达到不同员工之间的权限隔离,您可以使用统一身份认证服务(Identity and Access Management,简称IAM)进行精细的权限管理。该服务提供用户身份认证、权限分配、访问控制等功能,可以帮助您安全的控制华为云资源的 - [基本概念](https://support.huaweicloud.com/productdesc-codecheck/codecheck_pdtd_0011.md): 编程代码中,注释行数占总行数的比例。它是一个衡量代码可读性和文档质量的指标。注释率=注释行/(代码行+注释行)*100%。注释行:源代码中的注释或被注释掉的代码的行数。无意义的注释行(空的注释行、只包含特殊字符的注释行等)不计算在内。详情请参见查看代码度量。重复行数是指涉及至少一次重复的代码行数;重复块是指包含重复行的代码块(最小重复块定 ## 计费说明 - [计费概述](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0001.md): 通过阅读本文,您可以快速了解代码检查(CodeArts Check)服务的计费模式、计费项、续费、欠费等主要计费信息。计费模式代码检查服务采用包年/包月计费模式。包年/包月是一种预付费模式,即先付费再使用,按照订单的购买周期进行结算,因此在购买之前,您必须确保账户余额充足。代码检查服务采用包年/包月计费模式。包年/包月是一种预付费模式,即 - [计费模式概述](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0003.md): 代码检查服务采用包年/包月计费模式,提供资源扩展。包年/包月是一种先付费再使用的计费模式,适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式,您可以预先购买代码检查服务。本文将介绍包年/包月代码检查服务的计费规则。 - [包年/包月](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0005.md): 代码检查服务采用包年/包月、并发扩展计费模式,提供基础版、专业版套餐,以满足不同规模用户的使用需求。并支持安全增强能力、并发扩展能力叠加。不同版本套餐中,提供的功能特性及资源规格略有不同,详情请参见表1。代码检查资源扩展包:在CodeArts或CodeArts Check套餐基础上,可以购买资源扩展包。计费价格请以代码检查价格详情实际计算 - [资源扩展包](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0015.md): 代码检查提供的资源扩展包为并发扩展,采用包年/包月,可增加检查任务并发执行数。 - [计费项](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0017.md): 代码检查支持资源并发扩展,计费项为代码检查并发数。 - [续费概述](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0021.md): 包年/包月服务到期后会影响代码检查服务正常运行。如果您想继续使用,需要在指定的时间内为代码检查服务续费。代码检查服务在到期前续费成功,代码检查服务可正常使用,且代码检查任务的运行不受影响。代码检查服务到期后的状态说明,请参见到期后影响。代码检查服务续费相关的功能如表1所示。在套餐资源生命周期的不同阶段,您可以根据需要选择一种方式进行续费, - [手动续费](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0022.md): 可在“手动续费项”、“自动续费项”、“到期转按需项”、“到期不续费项”页签查询全部待续费项,对套餐进行手动续费的操作,具体操作请参见如何恢复为手动续费。统一到期日是指通过续费将包年/包月实例的到期日统一固定为一个月的某一天。如果您购买的代码检查服务套餐、资源扩展的到期日不同,可以将到期日统一设置到固定一个日期,便于日常管理和续费。图1展示 - [自动续费](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0023.md): 自动续费可以减少手动续费的管理成本,避免因忘记手动续费而导致代码检查服务资源被自动删除。自动续费的规则如下所述:以订单的到期日计算第一次自动续费日期和计费周期。订单自动续费周期以您选择的续费时长为准。例如,您选择了3个月,订单即在每次到期前自动续费3个月。在订单到期前均可开通自动续费,到期前7日凌晨3:00首次尝试自动续费,如果扣款失败, - [费用账单](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0024.md): 您可以在“费用中心 > 账单管理”查看资源的费用账单。购买代码检查服务套餐、资源扩展完成支付后,会实时上报一条账单到计费系统进行结算。 - [欠费说明](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0025.md): 用户在使用云服务时,账户的可用额度小于待结算的账单,即被判定为账户欠费。欠费后,可能会影响云服务资源的正常运行,请及时充值。自动续费情况下,可能会因持续性周期扣款而导致账户的余额不足。由于代码检查服务采用包年/包月计费方式,购买时已经预先支付了资源费用,因此在账户出现欠费的情况下,在资源到期前仍可正常使用代码检查服务。然而,对于涉及费用的 - [停止计费](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0026.md): 代码检查服务采用包年/包月计费模式,购买时进行一次性付费,订单到期后服务将会自动停止使用。如果在计费周期内不再使用代码检查服务,您可以执行退订服务,代码检查服务套餐、资源扩展包均支持退订。系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订规则概览。如果您已开启“自动续费 - [旧版代码检查计费方式如何收费?](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0007.md): 本章节仅供老用户参考。代码检查服务依赖需求管理服务,开通前请先开通需求管理服务。服务的开通需要区分区域,因此开通前注意选择自己需要开通的区域。服务开通后,需注意创建的资源也分区域。例如,在华北-北京四中创建了项目A,在下次查看项目A时,需先切换到项目A所在区域华北-北京四。例如,在华北-北京四中创建了项目A,在下次查看项目A时,需先切换到 - [旧版本开通/关闭按需计费方式说明](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0008.md): 本章节仅供老用户参考。CodeArts旧版计费包括包年/包月套餐购买及服务组合开通方式。也可单独开通代码检查服务。单独开通的计费方式请参见旧版代码检查计费方式如何收费?。请先注册华为账号并开通华为云(如果华为云账号已注册并开通华为云,请忽略该步骤),详细操作请参见注册华为账号并开通华为云。在开通记录页签可查看服务开通记录。为了避免不必要的 - [已开通旧版代码检查服务,能否转换为新版本计费?](https://support.huaweicloud.com/price-codecheck/codeartscheck_29_0009.md): 本章节仅供老用户参考。当前暂不支持已开通旧版代码检查服务的用户一键切换成新计费模式,需要将旧版服务套餐关闭,再购买新套餐。已购买包周期套餐的用户,套餐到期后,您可以选择继续购买包年/包月套餐,请参见包年/包月。开通旧版按需计费的用户,仍延续旧版按需计费规则。旧版代码检查服务关闭方式请参见关闭服务。 ## 快速入门 - [快速检查CodeArts Repo代码仓库中的代码质量](https://support.huaweicloud.com/qs-codecheck/codecheck_qs_1000.md): 在代码开发过程中,编程人员能力和代码风格不一致,会影响代码的可阅读性和可维护性,例如代码注释要求,或者在某个平台/行业的代码编写要求比较特殊等一系列问题,可通过使用代码检查服务检查代码质量。本示例为您演示检查CodeArts Repo代码仓库中的代码质量,帮助您快速建立对代码检查服务的整体印象。已注册华为云并实名认证,如果还没有华为账号, - [代码检查服务入门实践](https://support.huaweicloud.com/qs-codecheck/codeartscheck_qs_1001.md): 当用户开通代码检查服务后,可以根据不同的业务场景灵活使用。本文介绍常见的代码检查实践。 ## 用户指南 - [代码检查服务(CodeArts Check)使用流程](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_1002.md): 代码检查(CodeArts Check)是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上,为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面的质量报告、便捷的问题闭环处理流程,帮助企业有效管控代码质量,助力企业成功。 - [购买CodeArts Check](https://support.huaweicloud.com/usermanual-codecheck/codeartscheck_01_9003.md): 已注册华为云并实名认证,如果还没有华为账号,请参考以下步骤创建。打开华为云网站。单击注册,根据提示信息完成注册。注册成功后,系统会自动跳转至您的个人信息界面。参考实名认证完成个人或企业账号实名认证。打开华为云网站。单击注册,根据提示信息完成注册。注册成功后,系统会自动跳转至您的个人信息界面。注册成功后,系统会自动跳转至您的个人信息界面。参 - [配置CodeArts Check项目级角色权限](https://support.huaweicloud.com/usermanual-codecheck/devcloud_hlp_00101.md): 新增的成员需赋予指定的角色,不同角色具备的默认权限不同。各角色具备的默认权限如表1。已购买CodeArts Check。已参考华为云码道(CodeArts)的用户指南华为云码道(CodeArts)使用前准备添加CodeArts项目成员章节添加成员,并参考管理CodeArts项目角色权限章节为新增的成员赋予角色。服务入口单击立即使用,进入代 - [配置CodeArts Check项目级消息通知](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0100.md): CodeArts Check支持配置项目级消息通知,配置后,将生效于该项目下的所有代码检查任务。当事件发生时,系统以站内信的方式通知相关接收人。当事件发生时,系统以邮件的方式,通知相关接收人。如果用户在个人通知设置中打开了邮件通知且设置了正确的邮件地址,会同时收到邮件通知。当事件发生时,通过微信机器人的方式推送消息到企业微信群。当事件发生 - [新建任务分组](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0101.md): 对于在同一项目中的不同模块或使用场景不同的代码检查,CodeArts Check支持分组管理。当创建一个分组后,会默认同步创建一个未分组分组,若创建代码检查任务时未选择分组,则创建的检查任务归档在未分组中。最多支持创建100个分组。创建分组支持多层创建,最多支持3层。需要代码检查任务的编辑权限。若该项目的代码检查任务暂无分组,则单击“新建 - [配置租户级检查语言](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0103.md): 具有te_admin账号、租户空间管理员和租户空间所有者权限的用户可以配置需要的检查语言及其文件后缀(包含默认的最多50个),配置完成后,将影响创建代码检查任务中单任务可选的检查语言。单击,可修改用户新增的语言文件后缀。单击,可删除用户新增的语言文件后缀,系统内置语言只能查看不能删除。 - [创建代码检查任务](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0000.md): 创建代码检查任务是指用户通过代码检查工具,为特定的代码源(如 CodeArts Repo、GitHub、GitCode 等代码仓库)创建专项任务,以自动扫描和检测代码质量。通过自动化工具或平台,发现代码中的潜在错误、安全漏洞、性能问题和代码风格不一致等问题,保障代码质量和项目稳定性。本章节为用户介绍如何单个创建或批量创建不同代码源的代码检 - [配置代码检查任务预置规则集](https://support.huaweicloud.com/usermanual-codecheck/devcloud_hlp_00116.md): 规则集是一组用于代码检查的规则集合。根据不同的检查目标和需求,规则集有相应的分类,比如安全类、安卓应用、编程风格、编码规范等。用户可根据实际需要更换代码检查任务使用的规则集,新启用的规则集将在下一次执行检查时生效。查看预置规则集复制预置规则集查看使用规则集的任务列表修改默认规则集配置代码检查任务使用的规则集预置规则集清单多个编译语言的规则 - [配置代码检查任务自定义规则集](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0009.md): 代码检查服务除了可以使用预置规则集外,用户还可以根据实际需要自定义代码检查规则集,每个规则集中最少设置一条规则。目前仅支持配置单语言的规则集,即一个规则集只能配置同一种语言类型的检查规则。关于自定义规则集的限制:代码检查规则集提供了代码安全检查增强包功能,使用前请务必按需购买。购买了代码安全检查增强包后,Java、C++、Go和Pytho - [批量导出/导入规则集](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0104.md): 代码检查服务支持导出规则集,在其他region可导入再使用。上传的规则集文件压缩包最大支持1MB。只支持json格式文件。最多可导入5个规则集。导出的规则集zip包中的json文件中的规则配置信息示例如下:{ "id": "a86bf7c5172b40fc909f291247318151", "name": "cmetrcis-jav - [配置代码检查任务模型集](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0007.md): 模型可以理解为是对特定编程行为或系统交互的抽象表示,它定义了分析器应该如何理解和处理特定的代码模式或API调用。与规则不同的是,规则通常是描述什么是对的,什么是错的的检查条款,而模型则更关注代码在特定上下文中的行为特征。模型为分析器提供了关于代码行为的知识库,使其能够更准确地进行推理。模型主要是对函数的行为或者变量进行建模,例如mallo - [配置代码检查任务质量门禁](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_1004.md): 根据质量要求设置门禁阈值,即可了解您的项目是否已准备好投入生产。例如,实际的检查结果超出设置的门禁阈值,则表示当前项目还不具备生产条件。te_admin账号、租户空间管理员和租户空间所有者,具有更新租户级门禁配置信息的权限。门禁质量设置支持租户级、项目级以及任务级,优先级为租户级 > 项目级 > 任务级。入口分别如下:租户级:进入代码检查 - [配置代码检查任务定时执行](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0005.md): 根据实际需要,设置代码检查任务的执行计划,定时执行默认分支的检查任务。建议在非流水线使用情况下进行配置。配置当天时间间隔必须在5分钟以上。 - [配置代码检查任务消息通知](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0007.md): CodeArts Check的通知设置支持租户级、系统项目级、服务项目级和任务级,用户可以根据实际需求,设置代码检查任务事件类型的通知方式。入口分别如下:租户级消息通知,详情可参考配置租户级第三方消息通知。系统项目级:详情可参考项目级消息通知配置。服务项目级:进入项目详情页面,选择代码 > 代码检查 > 配置中心 > 通知管理。任务级:进 - [配置代码检查任务检查范围](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0022.md): 用户可以根据实际需求设置检查模式和检查目录,提高检查效率。secbrella引擎均不支持MR合入。C#语言仅支持全量检查。仅支持Repo代码源的任务设置,第三方代码源不支持修改。全量检查:对分支的全部文件进行检查,统计分支的所有代码问题。最近一次提交:对分支下最近一次提交涉及变更的文件进行检查,统计这些文件中的所有代码问题,含未修改部分的 - [查看徽标状态](https://support.huaweicloud.com/usermanual-codecheck/devcloud_hlp_00095.md): 执行完代码检查任务后,您可通过徽标状态查看代码健康度,并标识在代码仓库中。代码检查服务中设置各个告警级别的影响度如下:致命:5严重:3一般:1提示:0.1健康度=SUM ∑(告警数量*告警级别影响度)/代码量,各个健康度对应的标识如下:A:健康度<=0.001B:0.001 < 健康度 <=0.005C:0.005 < 健康度 <=0.0 - [配置代码检查任务集成服务](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0002.md): 当代码托管中有分支合并时,在代码检查服务中可以设置自动检查代码检查任务,并生成一个子任务,即代码仓库中有分支合并,就会重新生成一个代码检查子任务。进入代码检查任务详情页面。单击,在代码托管中新建MR请求。合并分支相关操作请参见代码托管用户指南。合并分支相关操作请参见代码托管用户指南。单击,通过下拉框中,可查看所有的MR触发代码检查的历史记 - [配置代码检查任务自定义环境](https://support.huaweicloud.com/usermanual-codecheck/codeartscheck_01_7033.md): 当使用代码检查服务时,若常用的编译构建环境缺少您需要的依赖包、工具,无法满足您的使用需求时,您可通过自定义构建环境提供的基础镜像执行代码检查任务。已将自定义环境推送到镜像仓中,具体操作请参见制作镜像并推送到SWR仓库。CodeArts Check默认引用项目下CodeArts Artifact中配置的私有依赖仓,同时支持用户通过配置私有依 - [配置代码检查任务高级选项](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0003.md): 在每个任务的基础上可以设置新问题起始时间。起始时间设置之后要重新扫描,问题的发现时间大于设置时间将被划分为新问题。如果没有设置起始时间,连续两次的检查结果对比,新增的就是新问题数。默认起始时间为当前任务第一次扫描成功的时间,起始时间之后扫描出的所有问题都将被划分为新问题。设置文件的编码方式,源文件编码会影响系统识别的源码内容的完整性,系统 - [配置代码检查显示引擎](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0109.md): IAM3.0场景下需要租户权限或者用户的te_admin角色才可以配置检查引擎开关。代码检查的引擎信息默认不显示,打开“显示检查引擎”的开关后导出任务告警、代码问题导出的文件、模型集、自定义规则集创建、自定义规则集管理界面、规则导出的文件、规则详情、规则描述、问题上下文和问题帮助才会显示引擎相关信息。 - [执行代码检查任务](https://support.huaweicloud.com/usermanual-codecheck/codecheck_02_0002.md): 用户可以对目标代码检查任务执行检查,及时发现源代码中的代码问题。执行代码检查有两种方式:手动执行:创建完代码检查任务后手动执行代码检查任务。本章节介绍的为手动执行代码检查任务的操作指导。定时执行:多用于日常执行代码检查,配置详情可参考配置代码检查任务定时执行。已创建代码检查任务。如果创建的是Repo代码源检查任务,则需要有代码仓库的访问权 - [查看代码检查结果](https://support.huaweicloud.com/usermanual-codecheck/codeartscheck_01_7008.md): 为了确保代码质量,及时发现并修复潜在的问题,代码检查任务执行完成后,需及时查看代码检查结果。查看代码检查详情查看代码问题查看代码度量查看检查日志您已创建并执行代码检查任务。代码检查结果包括检查详情、代码问题、代码度量和检查日志。新问题:表示本次代码检查任务执行后新增的问题。未解决:表示该代码检查任务未解决的问题。已解决:表示该代码检查任务 - [智能化生成代码修复建议](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0105.md): 执行代码检查任务后,对于检查出的待处理问题,可以通过智能化生成(支持批量或单个两种方式)代码修复建议来辅助快速修复代码问题,从而显著提升问题识别和修复建议的精准度,以及代码问题修复效率,更有效地保障了产品代码质量。智能化生成代码修复建议的功能目前仅支持JAVA、C/C++语言的部分规则,具体请参见下表:表 支持智能化生成代码修复建议的规则 - [智能化生成代码问题摘要](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0106.md): 请确认当前环境已支持智能化(导航栏中可以找到图标)。如果未支持,请提交工单联系技术支持工程师参考《华为云码道(CodeArts) 2.5.0 智能化安装指南(for 华为云Stack 8.6.0)》操作。请租户管理员在“租户设置 > 通用设置 > 服务级访问权限管理”页面为用户开启“智能助手”权限。 - [变更代码检查服务规格](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0006.md): 代码检查服务支持变更套餐规格,变更影响请参见变更配置后对计费的影响。代码检查并发扩展支持变更并发数。代码检查支持并发扩展,详情介绍请参见资源扩展包。 - [查询审计日志](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0004.md): 云审计服务是安全解决方案中专业的日志审计服务,记录了CodeArts Check的相关操作事件,方便用户日后的查询、审计和回溯。用户需要在云审计服务CTS的管理控制台查询CodeArts Check服务的事件列表。详情请参考查看审计事件。 - [CodeArts Check插件使用指南(IntelliJ IDEA版本)](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ref_0001.md): 本插件致力于守护开发人员代码质量,成为开发人员的助手和利器。秉承极简、极速、即时看护的理念,提供业界规范的检查、代码风格一键格式化及代码自动修复功能。使用Check插件时,IntelliJ IDEA的版本需要在2020.2~2024.3.7范围内。分为两种登录方式。方式一:通过华为云账号直接登录或CSDN账号授权登录CodeArts Ch - [VSCode 插件使用指南](https://support.huaweicloud.com/usermanual-codecheck/check_01_0001.md): CodeArts Check 是华为云提供的一款代码检查工具,旨在帮助开发者在开发过程中发现和修复代码质量问题。CodeArts Check 的 VSCode 插件是将 CodeArts Check 集成到 Visual Studio Code 中的一个扩展,使得开发者可以在 VSCode 中直接使用 CodeArts Check 的功能 - [安装CodeArts Check插件](https://support.huaweicloud.com/usermanual-codecheck/check_01_0002.md): 下载完成之后,界面右下角会变为“工具已是最新”的提示。 - [登录解锁配置界面](https://support.huaweicloud.com/usermanual-codecheck/check_01_0004.md): 需登录账号后才可以配置CodeArts Check插件功能。使用插件扫描无需登录账号。1.1.5及以上版本无需登录,可跳过此步骤。方式一:单击“华为IAM账号登录”按钮,打开IAM登录窗口。如果没有IAM账号,可以单击“创建IAM用户”按照操作指南创建。如果没有IAM账号,可以单击“创建IAM用户”按照操作指南创建。方式二:单击“华为账号 - [配置CodeArts Check插件](https://support.huaweicloud.com/usermanual-codecheck/check_01_0005.md): 配置无感扫描:即“代码编辑后保存,是否自动触发代码检查”。默认不勾选,勾选后会禁用其他的保存自动化能力,且编辑后保存文件会自动格式化整个文件和自动扫描。配置git代码提交时自动扫描:即“代码编辑后保存,是否自动格式化”。默认勾选,勾选后编辑后保存文件,会自动触发CodeArts Check扫描,结果自动刷新在问题窗口和CodeArts C - [使用CodeArts Check插件检查和修复文件](https://support.huaweicloud.com/usermanual-codecheck/check_01_0006.md): 以C/C++项目为例。本地选择一个C/C++项目。支持对单个C/C++文件或多个C/C++文件进行扫描检查,或对整个项目进行工程检查,还可以通过一键格式化对文件进行自动代码风格问题纠正等。单文件扫描检查:在当前打开的文件代码编辑区,单击鼠标右键,选择“CodeArts Check文件检查”。或者在项目的资源管理器界面里,鼠标移动到需要扫描 ## 最佳实践 - [CodeArts Check最佳实践汇总](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_0000.md): 本文汇总了基于代码检查服务(CodeArts Check)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松检查代码。 - [使用预置规则检查GitCode代码仓中的代码质量](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1005.md): 如果您的代码存放在GitCode代码仓中,可参考本实践的操作指导完成检查代码质量。本实践为您介绍如何使用系统预置规则检查GitCode代码仓中的Java语言代码质量。已开通并授权使用代码检查服务。GitCode代码仓中已有Java语言的代码。服务扩展点(Endpoint)是华为云码道的一种扩展插件,为华为云码道提供链接第三方代码仓的能力。 - [使用预置规则检查通用Git代码仓中的代码质量](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1002.md): 如果您的代码存放在通用Git代码仓中,可参考本实践的操作指导完成检查代码质量。本实践为您介绍如何使用系统预置规则检查通用Git代码仓中的Java语言代码质量。已开通并授权使用代码检查服务。通用Git代码仓中已有Java语言的代码。服务扩展点(Endpoint)是华为云码道的一种扩展插件,为软件华为云码道提供链接第三方代码仓的能力。代码检查 - [使用自定义规则检查CodeArts Repo代码仓中的代码质量](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1001.md): 随着现在项目的代码量越来越大,以及现有开发框架的增加,静态分析所需要覆盖的场景也日益增多,存在的问题如下:传统静态分析引擎靠工具提供通用规则来对常见安全,风格和质量场景下的编码问题进行扫描分析,难以实时覆盖不同用户特定场景下的代码问题。用户往往不熟悉工具提供的通用规则所能覆盖的全部场景。在为新开发的业务场景寻找适用的规则时需要耗费大量的时 - [不上传代码到云服务的情况下使用代码检查服务](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1008.md): 部分用户的代码有严格的保密机制,不允许将代码上传到外部网络,用户希望仅在信任的自有执行机上完成代码扫描服务。华为云CodeArts Check为此提供本实践的扫描方案,在不上传代码到云服务的情况下使用代码检查服务检查代码问题。使用自定义执行机功能为受限功能,如需使用,请提交工单联系技术支持工程师。本实践需购买虚拟专用网络VPN,关于VPN - [使用自定义执行机执行代码检查任务](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1007.md): 当CodeArts Check提供的内置执行机不满足业务要求时,您可接入自行提供的执行机,通过注册的方式托管到CodeArts Check服务中,委托CodeArts Check服务进行调度并执行代码检查任务。本实践通过检查CodeArts Repo代码仓的代码问题来演示使用自定义执行机执行代码检查任务。本实践需要依赖使用的其他服务:代码 - [CodeArts Check通过调用API执行MR增量检查](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1009.md): 在用户实际的使用场景中,用户往往有构建自己的代码质量管控平台,集成代码检查及其他检查项的需求。并且在用户的应用场景中,MR合入过程中的质量监控是一个高频应用场景。本示例介绍如何通过调用CodeArtsCheck API方式,执行MR增量代码检查并获取检查结果。通过调用CodeArtsCheck API可以不使用华为云前端,从而构建自己的全 - [使用Jenkins插件集成CodeArts Check执行代码检查](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1010.md): Jenkins是一款由Java编写的开源的持续集成工具,它运行在Servlet容器中(例如Apache Tomcat),可以通过各种方式触发构建。例如提交给版本控制系统时被触发、通过类似Cron的机制调度、或在其他的构建已经完成时通过一个特定的URL进行请求。利用Jenkins工具现有能力,实现代码检查服务的快速集成,包含执行检查、状态查 - [基于第三方引擎执行代码检查](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1011.md): 如果CodeArts Check当前提供的检查引擎不满足用户的使用需求,可使用第三方引擎检查工具执行代码检查任务。自定义执行机功能为受限功能,如需使用,请提交工单联系技术支持工程师。本实践需购买ECS作为自定义执行机,关于ECS的购买费用可参考价格计算器。已联系技术支持获取UCCP插件的代码开发样例包,如需帮助请提交工单联系技术支持工程师 - [安全执行代码检查任务](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1012.md): CodeArts Check提供代码安全检查增强包的能力,其安全检查能力作为深度价值特性,能深度识别代码中安全风险和漏洞,提供了套餐包内规则不覆盖的安全类场景,比如数值错误、加密问题、数据验证问题等。针对业界的安全漏洞检测项提供了更深入的分析能力,如跨函数、跨文件、污点分析、语义分析等。需参考购买CodeArts增值特性购买代码检查服务的 - [使用模型集执行代码检查](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1013.md): 在项目代码规模持续增长和开发框架多样化的情况下,静态分析模型的应用显得尤为重要,它主要为业务代码中的特定逻辑或框架要求(如自定义内存分配器my_malloc需配套my_free、如标记用户输入get_user_input()为不可信源)提供精准检查,弥补通用规则对定制化场景覆盖不足的问题。模型集为受限功能,仅购买代码检查安全增强包后才可使 - [HE2E DevOps实践之代码检查](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1003.md): 本文以“DevOps全流程示例项目”为例,介绍如何在项目中进完成代码检查配置。开展实践前,需要完成创建项目和创建仓库。样例项目中预置了以下4个代码检查任务。本章节以任务“phoenix-codecheck-worker”为例进行讲解。开发人员可以对样例项目中预置的任务做一些简单的配置,使检查更全面。本实践中以增加Python语言检查规则集 - [使用构建任务制作SonarQube工具镜像](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1015.md): 此时的目录结构如下图。删除第二行的“USER build”。从第二行开始写入如下内容:# Define build arguments and set default values # SonarQube Server version ARG SONARQUBE_VERSION=25.4.0.105899 # SonarScanner C - [手工制作SonarQube工具镜像](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1016.md): 若需要使用SonarQube社区版本,可以在如下官方链接中获取:SonarQube Server、SonarScanner CLI。将“SonarScanner CLI”放入“sonarqube”目录,结构如下:将Node.js环境放入“nodejs”目录,如果用户不检查JavaScript/TypeScript/CSS语言,则无需Nod - [导入SonarQube规则](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1017.md): 注意:上述导出的文件不能直接使用,需要拆分。每个租户支持的自定义规则数量取决于用户的套餐,参考代码检查规格与限制。导入规则文件支持创建者对自定义规则进行编辑和删除。单击“管理”,可以修改规则信息或删除此条规则。 - [SonarQube模板规则说明和配置自定义规则参数](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1018.md): 如果导入的规则有可配置的参数(Parameters)或者导入的规则是模板规则(Rule Template),可以在规则集中对该规则进行配置。可以在SonarQube Server上看出该规则是否支持配置选项。确定该规则支持配置选项参数后,在规则集中可以对参数进行配置。如下图,可以在SonarQube Server中查看规则是否是模板规则。 - [新增检查语言](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1019.md): 除了支持集成CodeArts Check系统内置语言的SonarQube规则,还支持集成非CodeArts Check系统内置语言的SonarQube规则,例如:Ruby、JSP、Kubernetes、Flex等语言的SonarQube规则。若确认所集成的SonarQube规则所属的语言不是CodeArts Check系统内置的语言,那么 - [使用SonarQube工具检查代码质量](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1020.md): 创建自定义规则集新建CodeArts Repo代码仓创建代码检查任务配置代码检查任务查看检查结果若用户选择的是手工制作SonarQube镜像,则在“镜像中自定义引擎的位置”中填写制作工具镜像步骤8-2中自定义目录。代码检查会自动拉取镜像,并将镜像中的“sonarqubecustom”所在目录(如:“/usr/local/tools”)下的 - [常见问题](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_1021.md): 问题现象:使用构建任务制作SonarQube镜像时报错“denied: You may not login yet”。原因分析:第一次上传的镜像默认为私有镜像,导致镜像无法拉取。处理方法:参考1.1.1-步骤11-2解决。问题现象:使用构建任务导出SonarQube规则Excel时候报错“./excute_py.sh: line 2: s ## API参考 - [使用前必读](https://support.huaweicloud.com/api-codecheck/codecheck_api_0000.md): 欢迎使用代码检查服务(CodeArts Check)。代码检查是基于云端实现代码质量管理的服务,软件开发者可在编码完成后执行多语言的代码静态检查和安全检查,获取全面的质量报告,并提供缺陷的分组查看与改进建议,有效管控代码质量,帮助产品成功。您可以使用本文档提供API对代码检查进行相关操作,如创建、删除、查询任务等。支持的全部操作请参见AP - [API概览](https://support.huaweicloud.com/api-codecheck/codecheck_03_0000.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [构造请求](https://support.huaweicloud.com/api-codecheck/codecheck_03_0007.md): 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户接口为例说明如何调用API。您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987 。尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强 - [认证鉴权](https://support.huaweicloud.com/api-codecheck/codecheck_03_0008.md): 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。Token认证:通过Token认证通用请求。AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。使用Token前请确保Token离 - [返回结果](https://support.huaweicloud.com/api-codecheck/codecheck_03_0009.md): 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。对于管理员创建IAM用户接口,如果调用后返回状态码为201,则表示请求成功。对应请求消息头,响应同样也有消息头,如Content-type。对于管理员创建IAM用户接口,返回如图1所 - [获取自定义执行机列表 - QueryOctopusResourcePools](https://support.huaweicloud.com/api-codecheck/QueryOctopusResourcePools.md): 用于查询用户已配置的自定义执行机资源池信息。用户可以通过此接口获取已创建的执行机资源池的名称和类型,支持通过资源池名称过滤。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tasks/{task_id} - [更新任务使用的执行机 - UpdateOctopusResourcePools](https://support.huaweicloud.com/api-codecheck/UpdateOctopusResourcePools.md): 更新任务使用的执行机资源池,支持设置当前任务执行时使用的资源池为默认资源池、专属资源池或自定义资源池。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v1/tasks/{task_id}/resource-p - [根据任务ID查询任务执行记录 - getJobsInfo](https://support.huaweicloud.com/api-codecheck/getJobsInfo.md): 当任务的执行记录比较多时,用户可根据任务ID、执行时间和任务执行状态分页查询任务下的执行记录。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/tasks/{task_id}/jobs状态码:200状态码 - [修改任务配置 - ModifyPipelineTaskV2](https://support.huaweicloud.com/api-codecheck/ModifyPipelineTaskV2.md): 修改代码检查任务部分配置,支持用户从Gitee仓切换到GitCode仓,支持修改任务的版本级检查模式。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v2/pipeline-task/{task_id}状态码 - [新建检查任务 - CreateTaskV2](https://support.huaweicloud.com/api-codecheck/CreateTaskV2.md): 在项目下新建代码检查任务,支持设置项目ID、代码仓地址、分支、规则集等信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v2/{project_id}/task状态码:200状态码:400状态码:401 - [删除检查任务 - DeleteTask](https://support.huaweicloud.com/api-codecheck/DeleteTask.md): 根据任务ID彻底删除代码检查任务,删除后任务的配置项、缺陷数据、执行记录等信息都不能恢复。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。DELETE /v2/tasks/{task_id}状态码:200请求成功!状态 - [查询任务列表 - ShowTaskListByProjectIdV2](https://support.huaweicloud.com/api-codecheck/ShowTaskListByProjectIdV2.md): 当代码检查任务较多时,用户可根据项目ID分页查询项目下的代码检查任务。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/{project_id}/tasks状态码:200状态码:400状态码:401状态码 - [执行检查任务 - RunTaskV2](https://support.huaweicloud.com/api-codecheck/RunTaskV2.md): 根据任务ID对任务所在的仓库和分支执行一次版本级扫描。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v2/tasks/{task_id}/run状态码:200状态码:400状态码:401执行检查任务:如需 - [终止检查任务 - StopTaskByIdV2](https://support.huaweicloud.com/api-codecheck/StopTaskByIdV2.md): 根据任务ID终止代码检查任务,可用来快速取消代码检查任务的执行。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v2/tasks/{task_id}/stop状态码:200请求成功!状态码:400状态码:4 - [查询任务执行状态 - ShowProgressDetailV2](https://support.huaweicloud.com/api-codecheck/ShowProgressDetailV2.md): 根据任务ID查询任务执行状态,只有正在检查中才有进度的详细信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/tasks/{task_id}/progress状态码:200状态码:400状态码:401 - [查询任务的已选规则集列表V2 - ListTaskRuleset](https://support.huaweicloud.com/api-codecheck/ListTaskRuleset.md): 根据项目ID和任务ID查询任务已选的规则集和可启用的规则集,返回规则集名称、ID、语言等信息,该接口不支持分页查询。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/{project_id}/tasks/ - [查询任务的已选规则集列表V3 - ShowTasksRulesets](https://support.huaweicloud.com/api-codecheck/ShowTasksRulesets.md): 根据项目ID和任务ID查询任务已选的规则集和可启用的规则集,返回规则集名称、ID、语言等信息,该接口支持分页查询。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v3/{project_id}/tasks/{ - [查询任务规则集的检查参数v2 - CheckParameters](https://support.huaweicloud.com/api-codecheck/CheckParameters.md): 根据项目ID、任务ID、规则集ID和规则集语言查询任务规则集的检查参数,返回检查工具ID、编译参数名称和检查参数配置信息,该接口不支持分页查询。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/{proj - [查询任务规则集的检查参数v3 - CheckRulesetParameters](https://support.huaweicloud.com/api-codecheck/CheckRulesetParameters.md): 根据项目ID、任务ID、规则集ID和规则集语言分页查询任务规则集的检查参数,返回检查工具ID、编译参数名称和检查参数配置信息,该接口支持分页查询。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v3/{pro - [配置任务编译配置 - ListTaskParameter](https://support.huaweicloud.com/api-codecheck/ListTaskParameter.md): 更新任务的规则集编译配置,支持设置规则集的编译配置。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v2/{project_id}/tasks/{task_id}/config-parameters状态码: - [修改任务规则集 - UpdateTaskRuleset](https://support.huaweicloud.com/api-codecheck/UpdateTaskRuleset.md): 修改代码检查任务的规则集配置,支持设置规则集ID、规则集语言和规则集的启用状态。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v2/tasks/{task_id}/ruleset状态码:200请求成功!状态 - [查询任务检查失败日志 - ShowTasklog](https://support.huaweicloud.com/api-codecheck/ShowTasklog.md): 根据项目ID、任务ID和执行记录ID查询任务的检查日志,没有传执行记录ID参数则查询任务下最近一次执行记录的检查日志。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/{project_id}/tasks - [获取任务的目录树 - ShowTaskPathTree](https://support.huaweicloud.com/api-codecheck/ShowTaskPathTree.md): 根据项目ID、任务ID和目录(文件)全路径分页查询任务的目录树,返回文件名(目录名)、文件(目录)全路径、是否叶子节点和文件忽略状态。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/{project_i - [任务配置屏蔽目录 - UpdateIgnorePath](https://support.huaweicloud.com/api-codecheck/UpdateIgnorePath.md): 根据项目ID、任务ID、文件路径或目录路径修改任务下文件或目录的屏蔽状态,文件或目录在设置成屏蔽状态后不会对其进行扫描。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v2/{project_id}/tas - [查询任务的高级配置 - ShowTaskSettings](https://support.huaweicloud.com/api-codecheck/ShowTaskSettings.md): 根据项目ID、任务ID和配置项列表分页查询任务的高级配置,返回高级配置的名称、取值、可选项。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/{project_id}/tasks/{task_id}/se - [设置任务的高级配置 - UpdateTaskSettings](https://support.huaweicloud.com/api-codecheck/UpdateTaskSettings.md): 根据项目ID、任务ID修改代码检查任务的高级配置的名称和取值。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v2/{project_id}/tasks/{task_id}/settings状态码:200请 - [查询分支任务列表 - ShowBranchTasks](https://support.huaweicloud.com/api-codecheck/ShowBranchTasks.md): 根据项目ID、任务ID和任务类型分页查询任务列表,可通过此接口查询任务下的分支任务、Tag任务、Mr任务和Commit任务。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v3/{project_id}/ta - [获取通知信息 - ShowNotification](https://support.huaweicloud.com/api-codecheck/ShowNotification.md): 根据任务ID查询任务在不同事件类型下的消息通知和邮件通知配置。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/task/notification/{task_id}状态码:200状态码:400状态码:4 - [获取租户下累计的代码检查数据 - ShowCodeSumMeasures](https://support.huaweicloud.com/api-codecheck/ShowCodeSumMeasures.md): 根据Token查询租户下累计检查的问题总数和代码行数。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tasks/code-sum-measures状态码:200状态码:400状态码:401获取租户下累 - [获取代码健康度徽标 - ShowCodeHealthSvg](https://support.huaweicloud.com/api-codecheck/ShowCodeHealthSvg.md): 根据任务ID、执行记录ID查询任务的代码健康度徽标状态,如果不传执行记录ID参数则查询最后一次执行成功的版本级检查任务的代码健康度徽标状态。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/task/{t - [获取代码仓所有文件 - ShowFileTree](https://support.huaweicloud.com/api-codecheck/ShowFileTree.md): 根据任务ID和文件路径查询任务的目录树,返回文件名(目录名)、文件(目录)全路径、是否叶子节点和文件忽略状态。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/tasks/{task_id}/all-fi - [获取代码仓所有文件列表 - ShowPortalServiceFileList](https://support.huaweicloud.com/api-codecheck/ShowPortalServiceFileList.md): 根据任务ID查询该任务对应代码仓的所有文件,返回的内容为文件的全路径列表。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/tasks/{task_id}/file-list状态码:200状态码:400状 - [查询责任人精确匹配开关 - ShowOwnerMatchingSwitch](https://support.huaweicloud.com/api-codecheck/ShowOwnerMatchingSwitch.md): 根据任务ID查询任务的责任人精确匹配开关,责任人精确匹配开关打开后,代码检查任务执行完成时可以匹配并显示每次代码提交的相关责任人。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tasks/{task_ - [设置责任人精确匹配开关 - UpdateOwnerMatchingSwitch](https://support.huaweicloud.com/api-codecheck/UpdateOwnerMatchingSwitch.md): 根据任务ID设置任务的责任人精确匹配开关,责任人精确匹配开关打开后,代码检查任务执行完成时可以匹配并显示每次代码提交的相关责任人。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v1/tasks/{task_ - [取消检查 - CancelPortalServiceJob](https://support.huaweicloud.com/api-codecheck/CancelPortalServiceJob.md): 根据任务ID、执行记录ID快速终止代码检查任务,不传执行记录ID则取消当前任务最近一次版本级任务。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v1/tasks/{task_id}/stop状态码:200状 - [根据任务ID获取任务Webhook URL以及开关状态 - ShowTaskWebhookInfo](https://support.huaweicloud.com/api-codecheck/ShowTaskWebhookInfo.md): 根据任务ID查询任务第三方消息通知配置,返回第三方消息通知类型、Webhook URL、密钥以及开关状态。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/tasks/{task_id}/task-web - [查询任务分支列表 - ListPortalServiceRepositoryBranches](https://support.huaweicloud.com/api-codecheck/ListPortalServiceRepositoryBranches.md): 根据任务ID、需要搜索的分支名分页查询任务下的分支列表。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/tasks/{task_id}/branches状态码:200状态码:400状态码:401查询ID - [获取指定第三方插件列表 - ListDataTransmissionServiceThirdPlugins](https://support.huaweicloud.com/api-codecheck/ListDataTransmissionServiceThirdPlugins.md): 根据配置模板ID查询任务下已配置的第三方插件,返回第三方插件的引擎名称、引擎执行命令和报告路径。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/plugins状态码:200状态码:400状态码:401查 - [更新指定id第三方插件列表 - UpdateDataTransmissionServiceThirdPlugins](https://support.huaweicloud.com/api-codecheck/UpdateDataTransmissionServiceThirdPlugins.md): 更新指定id第三方插件列表请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v2/plugins状态码:200更新指定id为897acf5exxx48a5013cd的第三方插件列表。状态码:200第三方插件配置 - [探测任务对应的代码仓语言 - RecognizePortalServiceCodeLanguage](https://support.huaweicloud.com/api-codecheck/RecognizePortalServiceCodeLanguage.md): 根据任务ID、扫描代码仓文件对任务所在的代码仓进行语言探测,探测到多个语言时将以英文逗号分隔并同时返回,方便用户根据探测结果启用语言对应规则集。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tasks - [查询租户或项目消息通知配置 - ShowDataTransmissionServiceNotification](https://support.huaweicloud.com/api-codecheck/ShowDataTransmissionServiceNotification.md): 根据租户ID或项目ID查询项目下不同事件类型的消息通知和邮件通知配置。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/transmission/notification状态码:200状态码:400状态码 - [列出项目下的分组信息 - ListPortalServiceTaskGroup](https://support.huaweicloud.com/api-codecheck/ListPortalServiceTaskGroup.md): 根据项目ID查询项目下的所有分组信息,返回分组ID、分组名和分组下的代码检查任务数。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/projects/{project_id}/task-groups状态 - [用于判断请求是否从租户配置的内网vpcep过来 - ShowVpcepAuthorization](https://support.huaweicloud.com/api-codecheck/ShowVpcepAuthorization.md): 根据任务ID查询任务所属租户是否配置了内网Vpcep安全访问。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/vpcep-authorization状态码:200状态码:400状态码:401用于判断请求 - [查询定时任务配置 - ShowPortalServiceTaskCron](https://support.huaweicloud.com/api-codecheck/ShowPortalServiceTaskCron.md): 根据任务ID查询任务的定时任务配置,返回定时任务的触发星期、触发时间、时区时间偏移量和定时任务开关。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tasks/{task_id}/taskcron状态码 - [获取租户检查工具版本 - ShowDataTransmissionServiceUserCheckersVersion](https://support.huaweicloud.com/api-codecheck/ShowDataTransmissionServiceUserCheckersVersion.md): 根据租户ID查询租户的检查工具版本,返回租户的工具版本、小工具版本和版本状态。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/{domain_id}/checkers-version状态码:200状态码 - [获取CodeHub代码仓列表 - GetCodeHubRepoList](https://support.huaweicloud.com/api-codecheck/GetCodeHubRepoList.md): 根据项目ID、需要搜索的代码仓名字分页查询项目下的CodeArtsRepo仓库,返回代码仓地址、仓库名和RepoId等信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/codehub/repo-li - [查询租户或项目门禁配置 - ShowDataTransmissionServiceReviewData](https://support.huaweicloud.com/api-codecheck/ShowDataTransmissionServiceReviewData.md): 根据租户ID或项目ID查询项目下的代码检查门禁配置,返回致命问题数、严重问题数、一般问题数和提示问题数的门禁阈值以及门禁开关的状态。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/transmissio - [查询租户套餐开通状态(含新旧版本) - ShowTenantPackageStatus](https://support.huaweicloud.com/api-codecheck/ShowTenantPackageStatus.md): 根据项目ID查询项目所属租户的套餐开通情况,返回主套餐详情、已购买的扩展包以及支持使用的规则集语言等信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/tenant/tenant-package-st - [查询最新的检查报告并刷新 - RefreshPortalServiceJobResult](https://support.huaweicloud.com/api-codecheck/RefreshPortalServiceJobResult.md): 当请求中的task_id不为空时,刷新最近一次检查成功的版本级任务的检查报告并返回刷新结果。当请求中的task_id为空时,刷新job_id对应的执行记录的检查报告并返回刷新结果。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限 - [查询模板任务列表 - ShowTemplateTasks](https://support.huaweicloud.com/api-codecheck/ShowTemplateTasks.md): 根据项目ID和需要搜索的模板任务名称分页查询项目下的模板任务,返回模板任务的模板任务ID、模板任务名、代码仓地址和分支名等信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/template-task - [获取最近执行的任务信息 - ShowLastJobs](https://support.huaweicloud.com/api-codecheck/ShowLastJobs.md): 根据任务ID查询任务下最近一次执行的执行记录ID和最近一次执行成功的执行记录ID。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/tasks/{task_id}/last-jobs状态码:200状态码: - [查询编译前执行的检查前置命令 - ShowPortalServicePreCheckScript](https://support.huaweicloud.com/api-codecheck/ShowPortalServicePreCheckScript.md): 根据任务ID查询任务的检查前置命令,检查前置命令在编译之前执行,方便用户搭建自定义的扫描环境。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tasks/{task_id}/pre-check-scri - [查询任务列表 - ShowTasksList](https://support.huaweicloud.com/api-codecheck/ShowTasksList.md): 根据项目ID、需要搜索的任务名、任务分组ID和任务执行状态分页查询项目下的代码检查任务,返回任务名称、代码仓地址、分支、配置模板ID和规则集等信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tas - [更新触发检查的webhook开关 - UpdateCodeCheckWebhook](https://support.huaweicloud.com/api-codecheck/UpdateCodeCheckWebhook.md): 根据任务ID设置任务集成服务的合并请求时触发开关和代码提交时触发开关,方便用户在CodeArtsRepo创建MR或者提交代码时自动触发代码检查任务。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v4/tas - [更新门禁配置 - UpdateCodeGate](https://support.huaweicloud.com/api-codecheck/UpdateCodeGate.md): 根据任务ID设置任务的致命问题数、严重问题数、一般问题数和提示问题数的质量门禁,在检查完成后,超过门禁阈值将提示门禁结果为Failed。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v1/task/code - [修改任务忽略文件 - UpdateIgnoreFiles](https://support.huaweicloud.com/api-codecheck/UpdateIgnoreFiles.md): 根据任务ID、文件(目录)路径、文件(目录)名、文件忽略状态修改任务的忽略文件配置,文件或目录在设置成忽略状态后不会对其进行扫描。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v4/task/{task_i - [修改MR检查模式 - UpdateMrCheckMode](https://support.huaweicloud.com/api-codecheck/UpdateMrCheckMode.md): 根据任务ID修改任务的MR检查模式,不同的MR检查模式有各自的扫描文件范围。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v1/task/check-mode状态码:200状态码:400状态码:401修改任 - [删除任务 - DeleteTaskV3](https://support.huaweicloud.com/api-codecheck/DeleteTaskV3.md): 根据任务ID彻底删除代码检查任务,删除后任务的配置项、缺陷数据、执行记录等信息不能恢复。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。DELETE /v3/task/{task_id}状态码:200状态码:400状态 - [根据任务ID查询检查任务 - GetTaskInfoByID](https://support.huaweicloud.com/api-codecheck/GetTaskInfoByID.md): 根据任务ID查询代码检查任务的基本信息,返回任务ID、任务名、项目ID、项目名、代码仓地址、分支和配置模板ID等信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v3/task/{task_id}状态码: - [查询指定代码检查任务的基本配置信息 - GetSimpleQueryConfigTemplate](https://support.huaweicloud.com/api-codecheck/GetSimpleQueryConfigTemplate.md): 根据配置模板ID查询代码检查任务的基本配置信息,返回配置模板ID、项目ID、项目名、代码仓地址、质量门禁配置和规则集等信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/simple-query/{i - [执行全量检查 - CreateJob](https://support.huaweicloud.com/api-codecheck/CreateJob.md): 根据任务ID对任务所在的分支执行一次版本级检查,返回任务ID、执行记录ID和执行人等信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/jobs状态码:200状态码:400状态码:401对任务ID为 - [批量异步复制任务 - BatchCopyAsyncTasks](https://support.huaweicloud.com/api-codecheck/BatchCopyAsyncTasks.md): 根据任务ID或者模板任务ID批量异步复制任务,待复制的任务支持重新设置项目ID、任务名、代码仓地址、分支名等参数,每个待复制的任务都会返回对应异步任务ID、复制进度等信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项 - [根据任务类型获取检查列表 - ShowCheckList](https://support.huaweicloud.com/api-codecheck/ShowCheckList.md): 根据任务ID和任务类型分页查询任务列表,可通过此接口查询任务下的分支任务、Tag任务、Mr任务和Commit任务。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v4/task/{task_id}/check - [新建检查任务V3 - CreateTaskV3](https://support.huaweicloud.com/api-codecheck/CreateTaskV3.md): 根据项目ID、代码仓地址、分支、任务名、规则集等参数在项目下新建一个代码检查任务,返回新建的代码检查任务的任务ID。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v3/task状态码:200状态码:400 - [查询系统配置 - ShowTenantSystemConfigs](https://support.huaweicloud.com/api-codecheck/ShowTenantSystemConfigs.md): 查询系统配置。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/system-configs状态码:200状态码:400状态码:401查询错误码为CC.10010263.500的系统配置详情。状态码:20 - [更新租户配置 - UpdateTenantConfig](https://support.huaweicloud.com/api-codecheck/UpdateTenantConfig.md): 更新租户配置。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v1/tenant-configs/{id}状态码:200状态码:400状态码:401修改系统配置ID为bbcc56db34b149f0a15bd - [删除租户配置 - DeleteTenantConfig](https://support.huaweicloud.com/api-codecheck/DeleteTenantConfig.md): 删除租户配置。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。DELETE /v1/tenant-configs/{id}状态码:200状态码:400状态码:401删除系统配置ID为bbcc56db34b149f0a1 - [查询租户配置 - ListTenantConfigs](https://support.huaweicloud.com/api-codecheck/ListTenantConfigs.md): 查询租户配置。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tenant-configs状态码:200状态码:400状态码:401查询前缀为languageFileSuffix的系统配置,实际上这个是 - [添加租户配置 - AddTenantConfig](https://support.huaweicloud.com/api-codecheck/AddTenantConfig.md): 添加租户配置。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/tenant-configs状态码:200状态码:400状态码:401添加一条key为languageFileSuffix_FORTRAN - [简单查询某个配置模板 - GetSimpleConfigTemplate](https://support.huaweicloud.com/api-codecheck/GetSimpleConfigTemplate.md): 简单查询某个配置模板。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/config/simple/{config_id}状态码:200状态码:400状态码:401状态码:200简单查询某个配置模板。状态 - [查询缺陷概要 - ShowTaskDetailV2](https://support.huaweicloud.com/api-codecheck/ShowTaskDetailV2.md): 该API用于查询缺陷结果的概要,根据任务ID参数返回包括问题概述、问题状态、圈复杂度、代码重复率等缺陷概要信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/tasks/{task_id}/defec - [查询代码度量概要 - ShowTaskCmetrics](https://support.huaweicloud.com/api-codecheck/ShowTaskCmetrics.md): 根据检查任务ID查询代码度量概要,包含代码行数、圈复杂度等度量指标。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/{project_id}/tasks/{task_id}/metrics-summar - [查询缺陷详情 - ShowTaskDefectsV2](https://support.huaweicloud.com/api-codecheck/ShowTaskDefectsV2.md): 根据检查任务ID分页查询任务检查结果的缺陷列表,支持通过问题状态、严重级别等参数筛选。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/tasks/{task_id}/defects-detail状态码: - [查询缺陷详情的统计 - ShowTaskDefectsStatisticV2](https://support.huaweicloud.com/api-codecheck/ShowTaskDefectsStatisticV2.md): 根据检查任务ID查询代码检查问题的统计信息,包含各个问题状态、问题级别的数量统计。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/tasks/{task_id}/defects-statistic状态码 - [修改缺陷状态 - UpdateDefectStatus](https://support.huaweicloud.com/api-codecheck/UpdateDefectStatus.md): 该API用于修改问题状态,可通过任务ID(task_id)和问题MergeKey(defect_id)等信息修改问题状态。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v2/tasks/{task_id}/ - [历史扫描结果查询 - CheckRecord](https://support.huaweicloud.com/api-codecheck/CheckRecord.md): 该API用于任务在某个时间段内每次扫描的缺陷问题数,通过请求任务ID(task_id)、时间段(start_time和end_time)等信息,返回各个问题级别统计信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。 - [获取规则列表接口 - ListRules](https://support.huaweicloud.com/api-codecheck/ListRules.md): 该API用于查询规则列表。可根据语言、问题级别等条件筛选查询。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/rules状态码:200状态码:400状态码:401状态码:200请求成功!状态码:400请 - [创建自定义规则集 - CreateRuleset](https://support.huaweicloud.com/api-codecheck/CreateRuleset.md): 该API用于新建自定义规则集。支持在创建的时候启用规则,可继承已创建的规则集,接口返回规则集的基本信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v2/ruleset状态码:201状态码:400状态码 - [查询规则集列表 - ListRulesets](https://support.huaweicloud.com/api-codecheck/ListRulesets.md): 该API用于查询规则集列表。支持根据项目ID、语言等条件筛选查询。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/{project_id}/rulesets状态码:200状态码:400状态码:401状态 - [查看规则集的规则列表 - ListTemplateRules](https://support.huaweicloud.com/api-codecheck/ListTemplateRules.md): 该API用于查询项目下某一规则集里的规则列表。可按照规则启用状态等条件筛选查询。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/{project_id}/ruleset/{ruleset_id}/rul - [删除自定义规则集 - DeleteRuleset](https://support.huaweicloud.com/api-codecheck/DeleteRuleset.md): 该API用于删除自定义规则集,正在使用中的规则集或默认规则集不能删除。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。DELETE /v2/{project_id}/ruleset/{ruleset_id}状态码:20 - [设置每个项目对应语言的默认规则集配置 - SetDefaulTemplate](https://support.huaweicloud.com/api-codecheck/SetDefaulTemplate.md): 该API用于设置项目下某一语言的默认规则集。设置默认规则集后,在该项目下创建这一语言的任务时,会默认配置该规则集。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v2/{project_id}/rulese - [查询规则集列表-V3 - ListRulesetsV3](https://support.huaweicloud.com/api-codecheck/ListRulesetsV3.md): 该API用于查询规则集列表。支持根据项目ID、语言等条件筛选查询。与V2接口相比,限制了分页参数大小,V2接口后续将下线。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v3/{project_id}/rul - [查询项目默认规则集 - ListDefaultSets](https://support.huaweicloud.com/api-codecheck/ListDefaultSets.md): 该API用于查询项目的各语言默认规则集。接口返回语言对应的默认规则集ID。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/criterionset/get-default-sets状态码:200状态码: - [根据语言查询规则集 - ListCriterionSetsByLanguage](https://support.huaweicloud.com/api-codecheck/ListCriterionSetsByLanguage.md): 该API用于查询项目下某一语言的规则集列表。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/criterionsets/language状态码:200状态码:400状态码:401状态码:200请求成功! - [获取规范信息 - ShowCriterionRule](https://support.huaweicloud.com/api-codecheck/ShowCriterionRule.md): 该API用于查询规范ID对应的规则信息。接口响应信息包含规范信息和工具规则信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/rule/criterion-rule/query/{criterion_ - [查询引擎支持的所有语言 - ListAllLanguage](https://support.huaweicloud.com/api-codecheck/ListAllLanguage.md): 该API用于查询当前环境中,引擎支持的所有语言。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/excute/language/all状态码:200状态码:400状态码:401状态码:200请求成功!状 - [根据规则集ID列表查询配置项 - ListConfigItemsByCriSetIds](https://support.huaweicloud.com/api-codecheck/ListConfigItemsByCriSetIds.md): 该API用于查询规则集里的规则关联的配置信息。该接口支持传多个规则集ID。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/config-items状态码:200状态码:400状态码:401状态码:20 - [批量查询规则集信息 - ListCriterionSetsByIds](https://support.huaweicloud.com/api-codecheck/ListCriterionSetsByIds.md): 该接口用于批量查询规则集信息。支持传多个规则集ID,接口响应返回查询的ID对应的规则集信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/criterionsets/batch状态码:200状态码: - [查询第三方引擎 - ShowThirdTools](https://support.huaweicloud.com/api-codecheck/ShowThirdTools.md): 该接口用于查询第三方引擎。用户可以导入第三方引擎的规则,该接口响应信息为用户租户下已导入的第三方引擎列表。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/excute/all-thirdtools状态码 - [查询规则集信息 - ShowSetInfo](https://support.huaweicloud.com/api-codecheck/ShowSetInfo.md): 该接口用于规则集ID对应的规则集信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/criterionsets/{set_id}状态码:200状态码:400状态码:401状态码:200请求成功!状态码 - [查询规则集列表-V2 - ListAllCriterionSets](https://support.huaweicloud.com/api-codecheck/ListAllCriterionSets.md): 该接口用于查询规则集列表,返回规则集详细信息。支持按照语言、规则集名字等筛选。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/all-criterionsets状态码:200状态码:400状态码:401 - [规则查询过滤器 - ShowFilter](https://support.huaweicloud.com/api-codecheck/ShowFilter.md): 该API用于查询按照条件筛选之后,各标签对应的规则数量。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/criterion-filters状态码:200状态码:400状态码:401查询过滤器。状态码:2 - [查询规则列表-V2 - ListCriterion](https://support.huaweicloud.com/api-codecheck/ListCriterion.md): 该API用于查询规则列表,返回规则的详细信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/criterions状态码:200状态码:400状态码:401状态码:200query criterions - [修改规则集中启用的规则 - ModifyCriterionIntoSet](https://support.huaweicloud.com/api-codecheck/ModifyCriterionIntoSet.md): 该API用于向规则集中添加规则或者删除规则,以及修改启用的规则配置参数,修改规则告警延迟时间,告警等级,规则适用范围。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/relations状态码:200状 - [更新代码问题状态 - UpdateIssueStatus](https://support.huaweicloud.com/api-codecheck/UpdateIssueStatus.md): 更新某个代码检查任务的某个代码问题状态,支持批量更新多个问题。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/defect/issue-status状态码:200状态码:400状态码:401将ID为8 - [获取代码问题列表 - IssueListByFilter](https://support.huaweicloud.com/api-codecheck/IssueListByFilter.md): 此API会根据参数中的筛选条件,返回符合条件的代码问题列表。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/defect/issue-list-by-filter状态码:200状态码:400状态码:4 - [获取代码问题统计 - IssueFilter](https://support.huaweicloud.com/api-codecheck/IssueFilter.md): 此API会根据参数中的筛选条件,返回符合条件的代码问题统计数据。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/defect/issue-filter状态码:200状态码:400状态码:401查询ID - [查询代码问题概览 - GetTaskStatistics](https://support.huaweicloud.com/api-codecheck/GetTaskStatistics.md): 查询版本级或门禁级扫描的代码问题概览。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/defects/task-statistics状态码:200状态码:400状态码:401查询ID为897acf5ex - [查询问题和度量趋势 - DisplayTrend](https://support.huaweicloud.com/api-codecheck/DisplayTrend.md): 查询指定时间内的每次扫描问题数量和度量指标趋势。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/history/defect-metric-trend状态码:200状态码:400状态码:401在ID为e - [查询问题状态修改的所有情形 - NextStatus](https://support.huaweicloud.com/api-codecheck/NextStatus.md): 根据当前调用方的租户,查询问题状态修改的所有情形。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/defects/next-status状态码:200状态码:400状态码:401查询当前租户问题状态修改 - [查询单个问题详情和上下文代码 - GetSingleDefect](https://support.huaweicloud.com/api-codecheck/GetSingleDefect.md): 根据MergeKey查询某个问题的详细信息及上下文代码。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/defect状态码:200状态码:400状态码:401查询ID为897acf5exxx48a501 - [恢复冷备份数据 - RecoverData](https://support.huaweicloud.com/api-codecheck/RecoverData.md): 恢复扫描结果数据。某个分支任务长时间未扫描过,扫描结果数据会被备份后删除,本接口可以对这类分支任务的数据进行恢复。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/task/recover-data状态 - [查询备份恢复状态 - GetBackupInfo](https://support.huaweicloud.com/api-codecheck/GetBackupInfo.md): 查询分支任务恢复进度以及备份状态。某个分支任务长时间未扫描过,扫描结果数据会被备份后删除,本接口可以查询分支任务的备份状态和恢复进度。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/backup/bac - [查询异步任务进度 - GetAsyncJob](https://support.huaweicloud.com/api-codecheck/GetAsyncJob.md): 根据生成PDF报告接口返回的asyncJobId,查询生成PDF的进度。当前接口已废弃,请使用查询异步任务进度V2接口。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tasks/{task_id}/a - [生成PDF报告 - PutPdfJob](https://support.huaweicloud.com/api-codecheck/PutPdfJob.md): 创建一个生成PDF的异步任务。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v1/tasks/{task_id}/pdf-async-job状态码:200状态码:400状态码:401对于ID为897acf5 - [下载PDF报告 - GetPdfFile](https://support.huaweicloud.com/api-codecheck/GetPdfFile.md): 根据查询查询异步任务进度V2接口返回的jobFile路径,下载对应的PDF报告,不支持重复下载。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tasks/{task_id}/pdf-file状态码:2 - [查询异步任务进度V2 - GetAsyncJobV2](https://support.huaweicloud.com/api-codecheck/GetAsyncJobV2.md): 根据生成PDF报告接口返回的asyncJobId,查询生成PDF的进度。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v2/async-job状态码:200状态码:400状态码:401查询ID为897acf - [获取代码度量不同范围内文件数量 - FilterMeasureTotal](https://support.huaweicloud.com/api-codecheck/FilterMeasureTotal.md): 统计代码圈复杂度、重复率在各个范围内的文件数量。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/measure/measure-total状态码:200状态码:400状态码:401查询ID为897ac - [查询代码度量概览 - GetTaskMeasures](https://support.huaweicloud.com/api-codecheck/GetTaskMeasures.md): 查询版本级或门禁级扫描的代码度量概览,包含任务的代码。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/defects/task-measures状态码:200状态码:400状态码:401查询ID为897 - [获取代码度量文件列表 - GetMeasureList](https://support.huaweicloud.com/api-codecheck/GetMeasureList.md): 根据任务ID等参数,分页获取文件的度量信息,包含文件代码重复率、重复行数、文件圈复杂度等度量指标。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tasks/{task_id}/measure-list - [查询重复代码块信息 - GetRelatedDuplicateBlocks](https://support.huaweicloud.com/api-codecheck/GetRelatedDuplicateBlocks.md): 查询文件下涉及的所有重复代码块,或查询与某个重复代码块重复的其他代码块。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/tasks/{task_id}/related-duplicate-blocks状 - [获取代码度量文件列表V2 - GetMeasureListV2](https://support.huaweicloud.com/api-codecheck/GetMeasureListV2.md): 根据任务ID等参数,分页获取文件的度量信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v2/measure/measure-list状态码:200状态码:400状态码:401查询ID为897acf5e - [获取重复文件代码 - GetMeasureDuplicationInfo](https://support.huaweicloud.com/api-codecheck/GetMeasureDuplicationInfo.md): 根据文件路径和起止行数或重复块ID,获取对应的文件代码。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/measure/measure-duplication-info状态码:200状态码:400状态 - [查询重复代码块信息V2 - GetRelatedDuplicateBlocksV2](https://support.huaweicloud.com/api-codecheck/GetRelatedDuplicateBlocksV2.md): 查询文件下涉及的所有重复代码块,或查询与某个重复代码块重复的其他代码块。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v2/related-duplicate-blocks状态码:200状态码:400状态 - [查询日志 - ShowLog](https://support.huaweicloud.com/api-codecheck/ShowLog.md): 查询代码检查日志,支持分页查询,由于后端会过滤敏感信息,所以返回行数会小于查询行数。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/console-log状态码:200状态码:400状态码:401状态码 - [下载日志文件 - DownloadLog](https://support.huaweicloud.com/api-codecheck/DownloadLog.md): 下载日志文件,下载结果为zip压缩包。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/log-file状态码:200状态码:400状态码:401状态码:400请求异常。状态码:401权限不足。请参见错误 - [智能化辅助分析任务摘要 - ExtractTaskAssistantSummary](https://support.huaweicloud.com/api-codecheck/ExtractTaskAssistantSummary.md): 通过智能化辅助分析,获取任务的摘要信息。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。POST /v1/defects/assistant-analysis/task-summary状态码:200状态码:400状态码 - [查看问题的源码文件 - ShowDefectsFileContent](https://support.huaweicloud.com/api-codecheck/ShowDefectsFileContent.md): 查看代码仓中问题所在的源码文件。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。GET /v1/defects/file-content状态码:200状态码:400状态码:401状态码:200Request succe - [提交修改的源码文件 - SubmitDefectsFileContent](https://support.huaweicloud.com/api-codecheck/SubmitDefectsFileContent.md): 提交修改后的代码到代码仓。请参见如何调用API。账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。PUT /v1/defects/file-content状态码:200状态码:400状态码:401状态码:200Request succeede - [示例1:查询任务列表](https://support.huaweicloud.com/api-codecheck/codecheck_03_0013.md): 本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。无。涉及的接口如下:查询任务列表 - ShowTaskListByProjectIdV2:根据DEVCLOUD_PROJECT_UUID查询任务列表。查询任务列表。接口相关信息URI格式:GET /v2/{project_id}/tasksURI格式:GE - [示例2:查询缺陷概要](https://support.huaweicloud.com/api-codecheck/codecheck_03_0014.md): 本章节指导用户根据检查任务ID查询缺陷结果的概要,包括问题概述、问题状态、圈复杂度、代码重复率等。任务存在。涉及的接口如下:查询缺陷概要 - ShowTaskDetailV2:查询缺陷概要,包括问题概述、问题状态、圈复杂度、代码重复率等。接口相关信息URI格式:GET /v2/tasks/{task_id}/defects-summary - [状态码](https://support.huaweicloud.com/api-codecheck/codecheck_03_0015.md): 状态码如表1所示。 - [错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.md): 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。当调用出错时,如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题。当接口调用出错时,会返回错误码及错误信息说明,错误响应的Bo - [获取IAM项目ID](https://support.huaweicloud.com/api-codecheck/codecheck_03_0010.md): 项目ID还可通过调用查询指定条件下的项目信息API获取。获取IAM项目ID的接口为GET https://{Endpoint}/v3/projects/,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。响应示例如下,其中projects下的id即为IAM项目ID。在调用接口的时候,部分URL中 - [获取CodeArts项目ID](https://support.huaweicloud.com/api-codecheck/CloudDeploy_api_0014.md): - [获取账号ID](https://support.huaweicloud.com/api-codecheck/codecheck_03_0011.md): 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下:登录管理控制台。鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。进入“我的凭证 > API凭证”页面,即可查看账号ID。进入“我的凭证 > API凭证”页面,即可查看账号ID。 - [Cmetrics工具规格说明](https://support.huaweicloud.com/api-codecheck/codecheck_03_0016.md): Cmetrics是华为公司自研代码度量工具,通过扫描源码对各项指标进行度量。度量指标包括代码量、函数圈复杂度、文件代码行、函数代码行、文件重复、代码重复、危险函数、冗余代码等多项指标。当前工具版本为2.1.5。 - [身份策略授权参考](https://support.huaweicloud.com/api-codecheck/Permission.md): 云服务在IAM预置了常用的权限,称为系统身份策略。如果IAM系统身份策略无法满足授权要求,管理员可以根据各服务支持的授权项,创建IAM自定义身份策略来进行精细的访问控制,IAM自定义身份策略是对系统身份策略的扩展和补充。除IAM服务外,Organizations服务中的服务控制策略(Service Control Policy,以下简称S - [修订记录](https://support.huaweicloud.com/api-codecheck/codecheck_03_0005.md): 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 ## 常见问题 - [执行代码检查任务时提示:任务正在执行,稍后重试](https://support.huaweicloud.com/codecheck_faq/codecheck_faq_0004.md): 执行任务失败,提示异常信息:任务正在执行,稍后重试。该任务正在运行,造成流水线执行失败。如果仍然未能解决,请提交工单联系技术支持工程师。 - [执行代码检查任务时提示:权限不足,请核对后再试](https://support.huaweicloud.com/codecheck_faq/codecheck_faq_0003.md): 执行任务失败,提示异常信息:权限不足,请核对后再试。当前用户操作权限不足,无法操作该任务,请用户根据权限矩阵,核对并联系项目管理员(项目创建者、项目经理)更改当前账号权限。 - [执行代码检查任务时提示:单个任务并发数超过套餐限制,任务无法下发](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0007.md): 执行代码检查时提示:单个任务并发数超过套餐限制,任务无法下发!多条流水线同时执行同一个代码检查任务,超过了并发上限。建议同时执行的任务少一点。 - [执行代码检查任务时提示:Cppcheck cannot tokenize the code correctly](https://support.huaweicloud.com/codecheck_faq/codecheck_02_1000.md): 代码检查提示Cppcheck cannot tokenize the code correctly。是Cppcheck的一条检查规则,在代码里面有语法错误,用Java语法写C代码造成的。要按照C语言的编码规范写代码,不能包含其他语言的编码规则。 - [执行代码检查任务时提示:no such file or directory](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0023.md): 代码检查任务失败,日志提示:no such file or directory。代码检查中用到自己封装的组件,未将组件上传到私有依赖库。已经将组件上传到私有依赖库,但用户账号没有此私有依赖库的授权,导致从私有依赖库中下载组件失败。操作方法请参见:管理用户权限。 - [执行代码检查任务时提示:在Maven仓库中找不到依赖](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0034.md): 代码检查报错,错误日志中提示在Maven仓库中找不到依赖(该依赖为私有依赖)。项目中使用了私有依赖,但没有配置私有依赖扩展点。 - [执行代码检查任务时提示:调用CodeArts Repo失败,未授权](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0035.md): 执行任务失败,提示异常信息:调用CodeArts Repo失败:未授权。无Repo代码仓访问权限。参考管理CodeArts权限,为成员添加代码仓访问权限。 - [执行代码检查任务时提示:CC.00070400.500](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0030.md): 执行代码检查任务时提示,入库告警超30W限制。使用当前的规则集扫描,告警问题数量超过30W。检查结果中展现了TOP10问题规则名称及其数量。用户可根据任务的具体情况删除问题数较多的规则,直至总问题数降至30W以下后,再次进行代码检查。操作步骤如下: - [单击任务名称时提示权限不足](https://support.huaweicloud.com/codecheck_faq/codecheck_faq_0001.md): 在代码检查服务任务列表中,单击任务名称,提示权限不足。操作的用户项目权限不足,当账号的项目权限为测试经理、测试人员(含跨租户)、浏览者(含跨租户)时,没有访问查看代码检查任务的权限。联系项目管理员(项目创建者、项目经理)修改当前账号角色。 - [C#前端使用WPF组件的项目检查失败](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0009.md): C# WPF项目检查失败。Linux mono不支持Windows WPF(Windows Presentation Foundation)。CodeArts中C#语言代码检查使用Linux mono方式时,C#前端WPF代码检查仅在Windows环境支持。 - [执行任务检查完成后没有代码问题](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0019.md): 在执行代码检查任务后没有代码问题,可能涉及以下三种原因:可能原因一:代码质量没有问题,无需处理。可能原因二:新建的代码任务语言规则集默认全部为打开状态,用户在已配置的代码仓库中新增了其他编程语言,但没有打开新增语言对应的规则集的开关,系统无法自动检测到这些新添加的语言,因此检查结果为空。可能原因三:代码仓库中存在多种编程语言,如果在任务设 - [TypeScript任务检查失败,日志显示404](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0001.md): TypeScript语言的任务检查失败,日志显示404。项目文件中包含了package-lock.json文件。在检查TypeScript语言的代码质量时,通常不应该包含package-lock.json文件,因为这个文件主要用于管理项目的依赖关系和版本锁定。在代码质量检查过程中,通常会忽略这个文件,因为它是根据项目中的package.j - [CC.00130044.400 Execute source plugin failed.](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0040.md): 如果日志中包含“The agent has not been fully initialized yet”表示引擎任务执行失败。参考本页面指导进行处理。如果日志中包含“ERROR during SonarScanner execution”,表示文件格式导致的编译失败。参考文件格式导致编译失败问题进行处理。扫描使用的规则集中规则过多。扫描 - [执行代码检查任务时报错:CC.00050032.400 没有可检查文件](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0033.md): 执行代码检查任务时,错误信息提示CC.00050032.400,没有可检查文件。配置了错误的检查目录,导致可扫描的代码源文件为空。设置了忽略文件后,未忽略的代码源文件为空。参考设置代码检查任务检查模式,填写正确的检查目录路径。 - [执行代码检查任务时报错:CC.00050050.400 源分支不存在](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0036.md): 执行代码检查任务时,错误信息提示CC.00050050.400,源分支不存在。代码托管中,对应代码仓的设置中开启了“新建合并请求,默认开启合并后删除源分支”开关,同时流水线配置“执行计划 > 事件触发 > 合并请求时触发”中,开启了“合并”选项,此时,源分支已删除,导致代码检查无法做差分扫描。 - [执行代码检查任务时报错:CC.00020413.553 调用CodeArts Repo失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0050.md): 执行代码检查任务时,错误信息提示CC.00020413.553,代码检查调用CodeArts Repo的接口失败。原因一:仓库不存在或仓库已被删除。原因二:未加入代码仓或者没有代码仓的读权限。原因三:部分历史数据没有添加委托账号为仓库成员,导致权限不足。原因一:在代码检查任务列表页,导航栏选择代码代码托管,查看代码检查任务使用的代码仓是否 - [执行代码检查任务时报错:CC.10010226.403 操作权限不足](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0150.md): 执行代码检查任务时,错误信息提示:CC.10010226.403,操作权限不足,请在项目内的设置-成员管理确认成员角色。操作代码检查任务时,没有代码检查相关的权限。例如,修改代码检查任务的任务名,需要有代码检查的检查任务的编辑权限。 - [执行代码检查任务时报错:CC.10010263.500 自定义执行机不可用](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0151.md): 执行代码检查任务时,错误信息提示:CC.10010263.500,自定义执行机不可用。用户设置了自定义执行机,但是自定义执行机没有配置正确。 - [执行代码检查任务时报错:CC.00030117.400 规则集无版本级规则,请检查规则集配置](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0155.md): 执行代码检查任务时,错误信息提示:CC.00030117.400,规则集无版本级规则,请检查规则集配置。用户配置的规则集没有版本级规则,但是执行了版本级扫描,需要重新配置规则集。 - [执行代码检查任务时报错:CC.00030308.400](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0156.md): 执行代码检查任务时,错误信息提示:CC.00030308.400。原因一:代码量过大,任务执行时间超出默认的超时时间。原因二:执行机规格不满足当前业务需求。原因三:代码检查任务的执行时间超过了配置的超时时间。原因一:减少单个代码检查任务的代码扫描量,可通过以下3种方式。将报错的代码检查任务拆分多个任务,并在拆分的任务中分别设置不同语言的规 - [执行代码检查任务时报错:CC.00030009.400 规则集信息不存在](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0157.md): 执行代码检查任务时,错误信息提示:CC.00030009.400,规则集信息不存在。没有配置扫描的规则集,比如代码仓为空或者缺少必要的代码文件,会导致无法选中规则集。 - [执行代码检查任务时报错:CC.00040010.400 代码检查失败,请到检查日志中查看具体错误信息](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0158.md): 华为云帮助中心,为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档,帮助您快速上手使用华为云服务。 - [文件格式导致编译失败问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0159.md): 日志中有Error during SonarScanner execution,且后续存在类似这种形式的日志。代码文件不规范导致解析失败。解决方案一:修改代码。修改日志指出的文件的代码。通过对日志进行全文搜索Caused by,可查看到具体代码问题。 如果通过Caused by搜索不到错误文件,可搜索sonarqube error lo - [unicode解析问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0160.md): sonarqube引擎的check阶段显示失败,并且日志里提示存在无法解析的字符。Java编译器不仅会编译代码,同时也会解析unicode字符,并且unicode字符的优先级最高。\u000d是换行符,在编译器中,会识别后续代码为下一行,所以不会显示格式问题。而在实际sonarqube分析中,\u000d所在行都已被注释,因此会多一个右括 - [findbugs规则在扫描jsp文件时报错](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0161.md): Findbugs分析的不是java源代码,而是编译后的class文件。通过下图进行配置忽略未编译的jsp文件。日志里有这种涉及jsp文件的警告时,需要在代码仓里排除.jsp文件。secsolar1130之后的版本可参考设置代码检查任务检查模式设置忽略jsp文件。secsolar1130之前的版本需要添加properties文件排除。在代码 - [代码检查任务,sonarqube引擎的check阶段失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0162.md): 代码检查任务,在sonarqube检查的check阶段失败,日志里存在elasticSearch启动报错max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]。系统默认环境配置的vm.max_map_count过 - [sonarqube引擎的check阶段失败日志里elasticSearch启动报错](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0163.md): elasticSearch启动报错max file descriptors [4096] for elasticsearch process is too low, increase to at least [65535]。单个进程可以同时打开的文件数太少。命令前需要注意带*号。 - [sonarqube引擎check阶段失败日志里elasticSearch启动报错](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0164.md): 系统最大线程个数太小。命令前需要注意带*号。 - [检查任务日志显示 Java heap space [ErrorMessage] className is java.util.Arrays, methodName is copyOf, lineNum is ***](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0165.md): Sonarqube引擎的check阶段失败,日志显示Java堆内存失败Java heap space [ErrorMessage] className is java.util.Arrays, methodName is copyOf, lineNum is ***。检测到的缺陷数过多,执行机内存有限,在转换缺陷报告过程中堆内存溢出导致失 - [Sonarqube检查css文件日志显示报错无扩展名问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0166.md): sonarqube引擎的check阶段失败,日志显示如图1。当前检查引擎sonar版本功能异常,在package.json文件中设置了"type":"module",导致CSS扫描程序在导入时缺少文件扩展名。未执行CSS规则,无法启动服务器。 - [执行启动脚本无权限问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0167.md): sonarqube引擎的check阶段失败,日志显示permission denied。执行机上,/devcloud目录没有slave1权限。 - [SCC初始化锁文件失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0168.md): sonarqube-check失败,日志显示scc initialize locking file failed。没有可用的锁。磁盘不支持lock锁,或者磁盘nfslock服务没有开启。如果系统提示nfslock服务不存在,可以尝试使用nfs-server或者nfs-kernel-server命令启动NFS服务。 - [sonarqube服务启动失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0169.md): sonarqube引擎的check阶段失败,日志显示failed to check alive interface , SonarQube service not alive。 可能elasticSearch初始化过程中恢复集群节点中止。 - [sonarqube服务的ES报错磁盘内存不足](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0170.md): sonarqube引擎的check阶段失败,日志显示如下:执行机磁盘空间不足,elasticSearch无法写入临时数据。联系技术支持人员清理磁盘。 - [编译脚本出错,导致检查失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0171.md): 代码检查失败,日志显示 :[ERROR] : script returned exit code 127,exitMessage is:command run failed。或 [ERROR] : script returned exit code 1,exitMessage is:command run failed。或 [ERROR - [内存不够,导致检查失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0172.md): 错误码为CC.00040010.400。日志里有显示Channel "unknown" : channel is already closed。代码量过大,引擎检查时执行机内存不够用。减少单个代码检查任务的代码扫描量,可通过以下3种方式。将报错的代码检查任务拆分多个任务,并在拆分的任务中分别设置不同语言的规则集。设置规则集可参考设置规则集 - [子模块代码下载失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0174.md): 错误码 CC.00040010.400检查日志里显示:Could not perform submodule update和and the repository exists,如下图所示。原因一:执行代码检查任务的子模块代码仓无权限。原因二:执行代码检查任务的子模块代码仓不存在。原因一处理方法:参考配置代码仓库级的权限,配置代码仓权限。原 - [打开代码检查页面出现弹窗提示:系统查询到当前任务存在备份,是否需要为您展示备份数据?](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0039.md): 在代码检查服务任务列表中,单击任务名称,进入任务页面后,出现弹窗提示:系统查询到当前任务存在备份,是否需要为您展示备份数据?代码检查会对长时间未进行过扫描的任务进行备份并清理。出现此提示说明该任务已经长时间未扫描过,数据已经被系统备份后删除,但此任务上的已忽略数据依然可以被其他分支或MR等继承。在弹出的弹窗中,选择“确定”或“取消”,如下 - [使用代码检查服务时报错:CC.10010295.403 用户已被禁用](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0173.md): 使用代码检查服务时,提示:用户已被禁用,请联系租户管理员确认用户状态。用户已被禁用。 - [执行代码检查任务后,查看问题单,页面提示:工作项已不存在](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0176.md): 执行代码检查任务成功后,代码问题默认创建了问题单,单击“查看问题单”,跳转至“工作项”页面后提示:工作项已不存在。历史问题产生的脏数据导致。不同用户不同任务但同样的代码问题(mergeKey一致),其中一个问题创建问题单,其他所有mergeKey一样的问题都会显示“查看问题单”按钮。 - [执行代码检查任务时提示:任务正在执行,稍后重试](https://support.huaweicloud.com/codecheck_faq/codecheck_faq_0004.md): 执行任务失败,提示异常信息:任务正在执行,稍后重试。该任务正在运行,造成流水线执行失败。如果仍然未能解决,请提交工单联系技术支持工程师。 - [执行代码检查任务时提示:权限不足,请核对后再试](https://support.huaweicloud.com/codecheck_faq/codecheck_faq_0003.md): 执行任务失败,提示异常信息:权限不足,请核对后再试。当前用户操作权限不足,无法操作该任务,请用户根据权限矩阵,核对并联系项目管理员(项目创建者、项目经理)更改当前账号权限。 - [执行代码检查任务时提示:单个任务并发数超过套餐限制,任务无法下发](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0007.md): 执行代码检查时提示:单个任务并发数超过套餐限制,任务无法下发!多条流水线同时执行同一个代码检查任务,超过了并发上限。建议同时执行的任务少一点。 - [执行代码检查任务时提示:Cppcheck cannot tokenize the code correctly](https://support.huaweicloud.com/codecheck_faq/codecheck_02_1000.md): 代码检查提示Cppcheck cannot tokenize the code correctly。是Cppcheck的一条检查规则,在代码里面有语法错误,用Java语法写C代码造成的。要按照C语言的编码规范写代码,不能包含其他语言的编码规则。 - [执行代码检查任务时提示:no such file or directory](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0023.md): 代码检查任务失败,日志提示:no such file or directory。代码检查中用到自己封装的组件,未将组件上传到私有依赖库。已经将组件上传到私有依赖库,但用户账号没有此私有依赖库的授权,导致从私有依赖库中下载组件失败。操作方法请参见:管理用户权限。 - [执行代码检查任务时提示:在Maven仓库中找不到依赖](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0034.md): 代码检查报错,错误日志中提示在Maven仓库中找不到依赖(该依赖为私有依赖)。项目中使用了私有依赖,但没有配置私有依赖扩展点。 - [执行代码检查任务时提示:调用CodeArts Repo失败,未授权](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0035.md): 执行任务失败,提示异常信息:调用CodeArts Repo失败:未授权。无Repo代码仓访问权限。参考管理CodeArts权限,为成员添加代码仓访问权限。 - [执行代码检查任务时提示:CC.00070400.500](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0030.md): 执行代码检查任务时提示,入库告警超30W限制。使用当前的规则集扫描,告警问题数量超过30W。检查结果中展现了TOP10问题规则名称及其数量。用户可根据任务的具体情况删除问题数较多的规则,直至总问题数降至30W以下后,再次进行代码检查。操作步骤如下: - [单击任务名称时提示权限不足](https://support.huaweicloud.com/codecheck_faq/codecheck_faq_0001.md): 在代码检查服务任务列表中,单击任务名称,提示权限不足。操作的用户项目权限不足,当账号的项目权限为测试经理、测试人员(含跨租户)、浏览者(含跨租户)时,没有访问查看代码检查任务的权限。联系项目管理员(项目创建者、项目经理)修改当前账号角色。 - [C#前端使用WPF组件的项目检查失败](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0009.md): C# WPF项目检查失败。Linux mono不支持Windows WPF(Windows Presentation Foundation)。CodeArts中C#语言代码检查使用Linux mono方式时,C#前端WPF代码检查仅在Windows环境支持。 - [执行任务检查完成后没有代码问题](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0019.md): 在执行代码检查任务后没有代码问题,可能涉及以下三种原因:可能原因一:代码质量没有问题,无需处理。可能原因二:新建的代码任务语言规则集默认全部为打开状态,用户在已配置的代码仓库中新增了其他编程语言,但没有打开新增语言对应的规则集的开关,系统无法自动检测到这些新添加的语言,因此检查结果为空。可能原因三:代码仓库中存在多种编程语言,如果在任务设 - [TypeScript任务检查失败,日志显示404](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0001.md): TypeScript语言的任务检查失败,日志显示404。项目文件中包含了package-lock.json文件。在检查TypeScript语言的代码质量时,通常不应该包含package-lock.json文件,因为这个文件主要用于管理项目的依赖关系和版本锁定。在代码质量检查过程中,通常会忽略这个文件,因为它是根据项目中的package.j - [CC.00130044.400 Execute source plugin failed.](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0040.md): 如果日志中包含“The agent has not been fully initialized yet”表示引擎任务执行失败。参考本页面指导进行处理。如果日志中包含“ERROR during SonarScanner execution”,表示文件格式导致的编译失败。参考文件格式导致编译失败问题进行处理。扫描使用的规则集中规则过多。扫描 - [执行代码检查任务时报错:CC.00050032.400 没有可检查文件](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0033.md): 执行代码检查任务时,错误信息提示CC.00050032.400,没有可检查文件。配置了错误的检查目录,导致可扫描的代码源文件为空。设置了忽略文件后,未忽略的代码源文件为空。参考设置代码检查任务检查模式,填写正确的检查目录路径。 - [执行代码检查任务时报错:CC.00050050.400 源分支不存在](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0036.md): 执行代码检查任务时,错误信息提示CC.00050050.400,源分支不存在。代码托管中,对应代码仓的设置中开启了“新建合并请求,默认开启合并后删除源分支”开关,同时流水线配置“执行计划 > 事件触发 > 合并请求时触发”中,开启了“合并”选项,此时,源分支已删除,导致代码检查无法做差分扫描。 - [执行代码检查任务时报错:CC.00020413.553 调用CodeArts Repo失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0050.md): 执行代码检查任务时,错误信息提示CC.00020413.553,代码检查调用CodeArts Repo的接口失败。原因一:仓库不存在或仓库已被删除。原因二:未加入代码仓或者没有代码仓的读权限。原因三:部分历史数据没有添加委托账号为仓库成员,导致权限不足。原因一:在代码检查任务列表页,导航栏选择代码代码托管,查看代码检查任务使用的代码仓是否 - [执行代码检查任务时报错:CC.10010226.403 操作权限不足](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0150.md): 执行代码检查任务时,错误信息提示:CC.10010226.403,操作权限不足,请在项目内的设置-成员管理确认成员角色。操作代码检查任务时,没有代码检查相关的权限。例如,修改代码检查任务的任务名,需要有代码检查的检查任务的编辑权限。 - [执行代码检查任务时报错:CC.10010263.500 自定义执行机不可用](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0151.md): 执行代码检查任务时,错误信息提示:CC.10010263.500,自定义执行机不可用。用户设置了自定义执行机,但是自定义执行机没有配置正确。 - [执行代码检查任务时报错:CC.00030117.400 规则集无版本级规则,请检查规则集配置](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0155.md): 执行代码检查任务时,错误信息提示:CC.00030117.400,规则集无版本级规则,请检查规则集配置。用户配置的规则集没有版本级规则,但是执行了版本级扫描,需要重新配置规则集。 - [执行代码检查任务时报错:CC.00030308.400](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0156.md): 执行代码检查任务时,错误信息提示:CC.00030308.400。原因一:代码量过大,任务执行时间超出默认的超时时间。原因二:执行机规格不满足当前业务需求。原因三:代码检查任务的执行时间超过了配置的超时时间。原因一:减少单个代码检查任务的代码扫描量,可通过以下3种方式。将报错的代码检查任务拆分多个任务,并在拆分的任务中分别设置不同语言的规 - [执行代码检查任务时报错:CC.00030009.400 规则集信息不存在](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0157.md): 执行代码检查任务时,错误信息提示:CC.00030009.400,规则集信息不存在。没有配置扫描的规则集,比如代码仓为空或者缺少必要的代码文件,会导致无法选中规则集。 - [文件格式导致编译失败问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0159.md): 日志中有Error during SonarScanner execution,且后续存在类似这种形式的日志。代码文件不规范导致解析失败。解决方案一:修改代码。修改日志指出的文件的代码。通过对日志进行全文搜索Caused by,可查看到具体代码问题。 如果通过Caused by搜索不到错误文件,可搜索sonarqube error lo - [unicode解析问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0160.md): sonarqube引擎的check阶段显示失败,并且日志里提示存在无法解析的字符。Java编译器不仅会编译代码,同时也会解析unicode字符,并且unicode字符的优先级最高。\u000d是换行符,在编译器中,会识别后续代码为下一行,所以不会显示格式问题。而在实际sonarqube分析中,\u000d所在行都已被注释,因此会多一个右括 - [findbugs规则在扫描jsp文件时报错](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0161.md): Findbugs分析的不是java源代码,而是编译后的class文件。通过下图进行配置忽略未编译的jsp文件。日志里有这种涉及jsp文件的警告时,需要在代码仓里排除.jsp文件。secsolar1130之后的版本可参考设置代码检查任务检查模式设置忽略jsp文件。secsolar1130之前的版本需要添加properties文件排除。在代码 - [代码检查任务,sonarqube引擎的check阶段失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0162.md): 代码检查任务,在sonarqube检查的check阶段失败,日志里存在elasticSearch启动报错max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]。系统默认环境配置的vm.max_map_count过 - [sonarqube引擎的check阶段失败日志里elasticSearch启动报错](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0163.md): elasticSearch启动报错max file descriptors [4096] for elasticsearch process is too low, increase to at least [65535]。单个进程可以同时打开的文件数太少。命令前需要注意带*号。 - [sonarqube引擎check阶段失败日志里elasticSearch启动报错](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0164.md): 系统最大线程个数太小。命令前需要注意带*号。 - [检查任务日志显示 Java heap space [ErrorMessage] className is java.util.Arrays, methodName is copyOf, lineNum is ***](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0165.md): Sonarqube引擎的check阶段失败,日志显示Java堆内存失败Java heap space [ErrorMessage] className is java.util.Arrays, methodName is copyOf, lineNum is ***。检测到的缺陷数过多,执行机内存有限,在转换缺陷报告过程中堆内存溢出导致失 - [Sonarqube检查css文件日志显示报错无扩展名问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0166.md): sonarqube引擎的check阶段失败,日志显示如图1。当前检查引擎sonar版本功能异常,在package.json文件中设置了"type":"module",导致CSS扫描程序在导入时缺少文件扩展名。未执行CSS规则,无法启动服务器。 - [执行启动脚本无权限问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0167.md): sonarqube引擎的check阶段失败,日志显示permission denied。执行机上,/devcloud目录没有slave1权限。 - [SCC初始化锁文件失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0168.md): sonarqube-check失败,日志显示scc initialize locking file failed。没有可用的锁。磁盘不支持lock锁,或者磁盘nfslock服务没有开启。如果系统提示nfslock服务不存在,可以尝试使用nfs-server或者nfs-kernel-server命令启动NFS服务。 - [sonarqube服务启动失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0169.md): sonarqube引擎的check阶段失败,日志显示failed to check alive interface , SonarQube service not alive。 可能elasticSearch初始化过程中恢复集群节点中止。 - [sonarqube服务的ES报错磁盘内存不足](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0170.md): sonarqube引擎的check阶段失败,日志显示如下:执行机磁盘空间不足,elasticSearch无法写入临时数据。联系技术支持人员清理磁盘。 - [编译脚本出错,导致检查失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0171.md): 代码检查失败,日志显示 :[ERROR] : script returned exit code 127,exitMessage is:command run failed。或 [ERROR] : script returned exit code 1,exitMessage is:command run failed。或 [ERROR - [内存不够,导致检查失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0172.md): 错误码为CC.00040010.400。日志里有显示Channel "unknown" : channel is already closed。代码量过大,引擎检查时执行机内存不够用。减少单个代码检查任务的代码扫描量,可通过以下3种方式。将报错的代码检查任务拆分多个任务,并在拆分的任务中分别设置不同语言的规则集。设置规则集可参考设置规则集 - [子模块代码下载失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0174.md): 错误码 CC.00040010.400检查日志里显示:Could not perform submodule update和and the repository exists,如下图所示。原因一:执行代码检查任务的子模块代码仓无权限。原因二:执行代码检查任务的子模块代码仓不存在。原因一处理方法:参考配置代码仓库级的权限,配置代码仓权限。原 - [文件格式导致编译失败问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0159.md): 日志中有Error during SonarScanner execution,且后续存在类似这种形式的日志。代码文件不规范导致解析失败。解决方案一:修改代码。修改日志指出的文件的代码。通过对日志进行全文搜索Caused by,可查看到具体代码问题。 如果通过Caused by搜索不到错误文件,可搜索sonarqube error lo - [unicode解析问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0160.md): sonarqube引擎的check阶段显示失败,并且日志里提示存在无法解析的字符。Java编译器不仅会编译代码,同时也会解析unicode字符,并且unicode字符的优先级最高。\u000d是换行符,在编译器中,会识别后续代码为下一行,所以不会显示格式问题。而在实际sonarqube分析中,\u000d所在行都已被注释,因此会多一个右括 - [findbugs规则在扫描jsp文件时报错](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0161.md): Findbugs分析的不是java源代码,而是编译后的class文件。通过下图进行配置忽略未编译的jsp文件。日志里有这种涉及jsp文件的警告时,需要在代码仓里排除.jsp文件。secsolar1130之后的版本可参考设置代码检查任务检查模式设置忽略jsp文件。secsolar1130之前的版本需要添加properties文件排除。在代码 - [代码检查任务,sonarqube引擎的check阶段失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0162.md): 代码检查任务,在sonarqube检查的check阶段失败,日志里存在elasticSearch启动报错max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]。系统默认环境配置的vm.max_map_count过 - [sonarqube引擎的check阶段失败日志里elasticSearch启动报错](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0163.md): elasticSearch启动报错max file descriptors [4096] for elasticsearch process is too low, increase to at least [65535]。单个进程可以同时打开的文件数太少。命令前需要注意带*号。 - [sonarqube引擎check阶段失败日志里elasticSearch启动报错](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0164.md): 系统最大线程个数太小。命令前需要注意带*号。 - [检查任务日志显示 Java heap space [ErrorMessage] className is java.util.Arrays, methodName is copyOf, lineNum is ***](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0165.md): Sonarqube引擎的check阶段失败,日志显示Java堆内存失败Java heap space [ErrorMessage] className is java.util.Arrays, methodName is copyOf, lineNum is ***。检测到的缺陷数过多,执行机内存有限,在转换缺陷报告过程中堆内存溢出导致失 - [Sonarqube检查css文件日志显示报错无扩展名问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0166.md): sonarqube引擎的check阶段失败,日志显示如图1。当前检查引擎sonar版本功能异常,在package.json文件中设置了"type":"module",导致CSS扫描程序在导入时缺少文件扩展名。未执行CSS规则,无法启动服务器。 - [执行启动脚本无权限问题](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0167.md): sonarqube引擎的check阶段失败,日志显示permission denied。执行机上,/devcloud目录没有slave1权限。 - [SCC初始化锁文件失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0168.md): sonarqube-check失败,日志显示scc initialize locking file failed。没有可用的锁。磁盘不支持lock锁,或者磁盘nfslock服务没有开启。如果系统提示nfslock服务不存在,可以尝试使用nfs-server或者nfs-kernel-server命令启动NFS服务。 - [sonarqube服务启动失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0169.md): sonarqube引擎的check阶段失败,日志显示failed to check alive interface , SonarQube service not alive。 可能elasticSearch初始化过程中恢复集群节点中止。 - [sonarqube服务的ES报错磁盘内存不足](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0170.md): sonarqube引擎的check阶段失败,日志显示如下:执行机磁盘空间不足,elasticSearch无法写入临时数据。联系技术支持人员清理磁盘。 - [编译脚本出错,导致检查失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0171.md): 代码检查失败,日志显示 :[ERROR] : script returned exit code 127,exitMessage is:command run failed。或 [ERROR] : script returned exit code 1,exitMessage is:command run failed。或 [ERROR - [内存不够,导致检查失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0172.md): 错误码为CC.00040010.400。日志里有显示Channel "unknown" : channel is already closed。代码量过大,引擎检查时执行机内存不够用。减少单个代码检查任务的代码扫描量,可通过以下3种方式。将报错的代码检查任务拆分多个任务,并在拆分的任务中分别设置不同语言的规则集。设置规则集可参考设置规则集 - [子模块代码下载失败](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0174.md): 错误码 CC.00040010.400检查日志里显示:Could not perform submodule update和and the repository exists,如下图所示。原因一:执行代码检查任务的子模块代码仓无权限。原因二:执行代码检查任务的子模块代码仓不存在。原因一处理方法:参考配置代码仓库级的权限,配置代码仓权限。原 - [打开代码检查页面出现弹窗提示:系统查询到当前任务存在备份,是否需要为您展示备份数据?](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0039.md): 在代码检查服务任务列表中,单击任务名称,进入任务页面后,出现弹窗提示:系统查询到当前任务存在备份,是否需要为您展示备份数据?代码检查会对长时间未进行过扫描的任务进行备份并清理。出现此提示说明该任务已经长时间未扫描过,数据已经被系统备份后删除,但此任务上的已忽略数据依然可以被其他分支或MR等继承。在弹出的弹窗中,选择“确定”或“取消”,如下 - [使用代码检查服务时报错:CC.10010295.403 用户已被禁用](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0173.md): 使用代码检查服务时,提示:用户已被禁用,请联系租户管理员确认用户状态。用户已被禁用。 - [执行代码检查任务后,查看问题单,页面提示:工作项已不存在](https://support.huaweicloud.com/codecheck_faq/codeartscheck_02_0176.md): 执行代码检查任务成功后,代码问题默认创建了问题单,单击“查看问题单”,跳转至“工作项”页面后提示:工作项已不存在。历史问题产生的脏数据导致。不同用户不同任务但同样的代码问题(mergeKey一致),其中一个问题创建问题单,其他所有mergeKey一样的问题都会显示“查看问题单”按钮。 - [使用公共API时提示没有权限](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0020.md): 使用公共API报没有权限。登录的用户没有权限。Region信息不对。如果仍然未能解决,请提交工单联系技术支持工程师。 - [使用公用API时提示项目不存在](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0021.md): 使用公用API提示项目不存在。taskId错误导致。使用正确的taskId。如果仍然未能解决,请提交工单联系技术支持工程师。 - [使用公共API时提示没有权限](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0020.md): 使用公共API报没有权限。登录的用户没有权限。Region信息不对。如果仍然未能解决,请提交工单联系技术支持工程师。 - [使用公用API时提示项目不存在](https://support.huaweicloud.com/codecheck_faq/codecheck_02_0021.md): 使用公用API提示项目不存在。taskId错误导致。使用正确的taskId。如果仍然未能解决,请提交工单联系技术支持工程师。