检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置代码检查任务质量门禁 根据质量要求设置门禁阈值,即可了解您的项目是否已准备好投入生产。例如,实际的检查结果超出设置的门禁阈值,则表示当前项目还不具备生产条件。 门禁质量设置支持租户级、项目级以及任务级,优先级为租户级 > 项目级 > 任务级。入口分别如下: 租户级:进入代码检
身份认证与访问控制 身份认证 用户访问代码检查服务的方式有多种,包括代码检查用户界面、API、SDK,无论访问方式封装成何种形式,其本质都是通过代码检查提供的REST风格的API接口进行请求。 代码检查的接口需要经过认证请求后才可以访问成功。代码检查支持两种认证方式: Token
一站式问题闭环修复 一站式问题闭环修复,问题修复效率倍增 开发团队实施代码检查活动时通常遇到问题分析和修复成本高(工具问题不易理解、问题分到具体开发人员费时费力、多版本情况下重复处理同一告警令开发人员厌倦工具)导致落地困难,这些原因很大程度影响了开发人员对检查工具的使用积极性。
“代码编写、代码合并、版本发布”三层缺陷防护 “代码编写、代码合并、版本发布”三层缺陷防护,兼顾效率与质量 优秀的代码质量保障实践,往往将代码检查融入到开发作业流中,在用户代码编写、代码提交时进行自动化的审计检查,并对团队每日产出的代码进行持续编程规范和质量检查。 这一活动实践要
配置代码检查任务消息通知 您可以根据实际需求,设置代码检查任务事件类型的通知方式。 例如,当检查任务的门禁失败时,可以设置以服务动态或邮件方式通知用户,并可配置通知的接收者角色和自定义成员。若不配置接收者角色及成员,门禁失败时向任务执行者发送通知;若配置,则向任务执行者、配置的接收者角色以及自定义成员发送通知。
配置代码检查任务自定义规则集 代码检查服务除了可以使用预置规则集类型,用户还可以根据实际需要自定义代码检查规则集,每个规则集中最少设置一条规则。 目前仅支持配置单语言的规则集,即一种规则集只能配置同一种语言类型的检查规则。 代码检查规则集提供了代码安全检查增强包功能,使用前请务必
手动续费 在云服务控制台续费 登录管理控制台。 单击左侧导航栏的图标,选择“开发与运维 > 代码检查 CodeArts Check”。 在页面订单列表中,单击待续费订单右上角“续费”。 进入“续费”页面,根据续费时长,判断是否勾选“统一到期日”,将资源到期时间统一到各个月的某一天
任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 设置媒体类型和编码格式
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 设置媒体类型和编码格式
Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素]
购买CodeArts Check 前提条件 已注册华为云并实名认证,如果还没有华为账号,请参考以下步骤创建。 打开华为云网站。 单击“注册”,根据提示信息完成注册。 注册成功后,系统会自动跳转至您的个人信息界面。 参考实名认证完成个人或企业账号实名认证。 购买CodeArts Check须知
功能总览 功能总览 全部 代码检查 计费说明 规则集设置 任务设置 API 代码检查 CodeArts Check(原CodeCheck)是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量,助力企业成功。
资源扩展包 代码检查提供的资源扩展包为并发扩展,采用包年/包月,可增加检查任务并发执行数。 代码检查并发扩展 表1 代码检查并发扩展 计费方式 包年/包月 适用场景 当代码检查服务套餐中包含的代码检查任务并发数不满足实际使用需求时,可购买代码检查并发扩展。 计费项 并发数。 购买限制
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限,详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
配置代码检查任务检查模式 您可以根据实际需求设置检查模式和检查目录,提高检查效率。 C#语言和secbrella引擎均不支持MR合入。 设置检查模式 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。 进入“代码检查详情”页面,选择“设置
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需
执行代码检查任务 用户可以对目标代码检查任务执行检查,及时发现源代码中的代码问题。 执行代码检查有两种方式: 手动执行:创建完代码检查任务后手动执行代码检查任务。本章节介绍的为手动执行代码检查任务的操作指导。 定时执行:多用于日常执行代码检查,配置详情可参考配置代码检查任务定时执行。
配置代码检查任务高级选项 配置新问题起始时间 在每个任务的基础上可以设置新问题起始时间。起始时间设置之后要重新扫描,问题的发现时间大于设置时间将被划分为新问题。如果没有设置起始时间,连续两次的检查结果对比,新增的就是新问题数。 基于项目入口访问CodeArts Check服务首页。
查询任务的高级配置 功能介绍 查询任务的高级配置 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID
查看代码检查结果 前提条件 您已创建并执行代码检查任务。 查看代码检查详情 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,搜索目标任务。在任务列表页,可以查看检查任务的状态。 新问题:表示本次代码检查任务执行后新增的问题。 未解决:表示该代码检查任务未解决的问题。