检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 API概览 如何调用API 附录 常见问题 了解更多常见问题、案例和解决方案 热门案例 执行代码检查任务时提示：no such file or directory 任务执行完成后没有数据 更多 技术类问题 执行代码检查任务时提示：任务正在执行，稍后重试 更多 API类问题
数据保护技术 代码检查通过多种数据保护手段和特性，保障数据安全可靠。 数据保护手段 简要说明 详细介绍 传输加密（HTTPS） 为保证数据传输的安全性，代码检查使用HTTPS传输数据。 构造请求 个人数据保护 通过控制个人数据访问权限以及记录操作日志等方法防止个人数据泄露，保证您的个人数据安全。
不上传代码到云服务的情况下使用代码检查服务 应用场景 部分用户的代码有严格的保密机制，不允许将代码上传到外部网络，用户希望仅在信任的自有执行机上完成代码扫描服务。华为云CodeArts Check为此提供本实践的扫描方案，在不上传代码到云服务的情况下使用代码检查服务检查代码问题。
Service，CTS），是华为云安全解决方案中专业的日志审计服务，提供对各种云资源操作记录的收集、存储和查询功能，可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 用户开通云审计服务并创建和配置追踪器后，CTS可记录代码检查的管理事件和数据事件用于审计。 CTS的详细介绍和开通配置方法，请参见CTS快速入门。
任务执行完成后没有数据 问题现象 任务执行检查完毕后没有数据。 原因分析 源代码仓语言没有获取到。 检查语言开关没有打开。 处理方法 进入任务“设置 > 规则集”页面。 单击“已包含语言”所在行重新获取代码仓语言。 打开需要检查语言的开关。 重新执行检查。 父主题： 技术类问题
服务韧性 代码检查通过多活无状态的跨AZ部署、AZ之间数据容灾等技术方案，保证业务进程故障时快速启动并修复，以保障服务的持久性和可靠性。 父主题： 安全
应用：在交付过程中实时根据代码复杂度、重复率、质量得分控制风险。 场景特点：项目经理的共识“从前端保证质量，把质量做在日常交付”，但经常没有有效的工具平台，目前大部分的质量工作还是依赖后端测试。 适用场景：项目经理迭代交付质量控制。
安全 责任共担 身份认证与访问控制 数据保护技术 审计与日志 服务韧性 认证证书
域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任，如图1所示。 华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的IaaS、PaaS和SaaS类云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等
查技术积累与企业级应用经验的沉淀之上，为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力，提供全面质量报告、便捷闭环处理问题，帮助企业有效管控代码质量，助力企业成功。 产品形态包括：云服务和IDE插件。同时，还提供具有深度检查能力的代码检查安全增强包。 云服务代码检查功能列表
错误码 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时，如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时，可以联系华为云客服，并提供错误码，以便我们尽快帮您解决问题。
CodeArtsCheck API可以不使用华为云前端，从而构建自己的全流程代码质量管控平台，同时也可以实现对非Codearts Repo代码仓的门禁级检查。本示例将以通用Git为例，进行方案介绍。 约束限制 每个通用Git扩展点仅能对接单个代码仓地址，同时1个CodeArts项目下的扩展点数量限制为1000。
CodeArts Check最佳实践汇总 本文汇总了基于代码检查服务（CodeArts Check）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松检查代码。 表1 CodeArts Check最佳实践一览表 最佳实践 说明 使用预置规则检查GitCode代码仓中的代码质量
查询审计日志 云审计服务是安全解决方案中专业的日志审计服务，记录了CodeArts Check的相关操作事件，方便您日后的查询、审计和回溯。 支持审计日志的操作 表1 云审计服务支持CodeArts Check服务操作 操作名称 资源类型 事件名称 创建代码检查任务 task create
攻击者利用外部输入构造系统命令，通过可以调用系统命令的应用，实现非法操作的目的。 支持 支持 路径遍历 不支持 支持 攻击者利用系统漏洞访问合法应用之外的数据或文件目录，导致数据泄露或被篡改。 不支持 支持 SQL注入 支持 支持 攻击者利用事先定义好的查询语句，通过外部输入构造额外语句，实现非法操作的目的。
认证证书 合规证书 华为云服务及平台通过了多项国内外权威机构（ISO/SOC/PCI等）的安全合规认证，用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求，具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书
Repo代码仓库中的代码质量 在代码开发过程中，编程人员能力和代码风格不一致，会影响代码的可阅读性和可维护性，例如代码注释要求。或者在某个平台/行业的代码编写要求比较特殊等一列问题，可通过使用代码检查服务检查代码质量。 本示例为您演示检查CodeArts Repo代码仓库中的代码
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
代码检查服务（CodeArts Check）使用流程 代码检查（CodeArts Check）是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上，为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力，提供全面的质量报告、便捷的问题闭环处理流程，帮助企业有效管控代码质量，助力企业成功。
包含执行检查、状态查询、报告输出等基本扫描流程。用户可根据基础方案进行自定义开发。 本文介绍如何通过Jenkins工具及CodeArtsCheck API，实现代码检查服务集成与调度。本示例将以通用Git为例，进行方案介绍。 约束限制 代码源为非同一CodeArts项目下的Repo仓时需使用扩展点进行代码源接入。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
