检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
华为云:负责云服务自身的安全,提供安全的云。华为云的安全责任在于保障其所提供的IaaS、PaaS和SaaS类云服务自身的安全,涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身,也包括运维运营安全,以及更广义的安全合规遵从。
支持代码规范检查、安全检查、代码重复率和圈复杂度检查。 兼容CWE/HUAWEI/OWASP TOP 10/ISO 5055/SANS TOP 25/CERT/MISRA安全标准。 易用 支持多种语言混合检查。 配置任务一键执行,批量过滤缺陷,分级分类快速处理。 支持代码安全检查
欢迎使用代码检查服务(CodeArts Check)。代码检查是基于云端实现代码质量管理的服务,软件开发者可在编码完成后执行多语言的代码静态检查和安全检查,获取全面的质量报告,并提供缺陷的分组查看与改进建议,有效管控代码质量,帮助产品成功。 您可以使用本文档提供API对代码检查进行
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
参考 CodeArts Check插件使用指南(IntelliJ IDEA版本)
操作名称 资源类型 事件名称 创建代码检查任务 task create 修改代码检查任务 task modify 删除代码检查任务 task delete 执行代码检查任务 job create 取消执行代码检查任务 job modify_job 关注代码检查任务 followingTask
修改“请求示例”中URL地址信息。 修改终端节点。 2020-07-01 第三次正式发布。本次变更说明如下: 修改代码示例中代码仓库地址信息。 2020-03-13 第二次正式发布。本次变更说明如下: 代码检查API接口项增加变更说明,如有疑问,请在帮助页面下方提交反馈。 2020-01-03 第一次正式发布。
数据保护技术 代码检查通过多种数据保护手段和特性,保障数据安全可靠。 数据保护手段 简要说明 详细介绍 传输加密(HTTPS) 为保证数据传输的安全性,代码检查使用HTTPS传输数据。 构造请求 个人数据保护 通过控制个人数据访问权限以及记录操作日志等方法防止个人数据泄露,保证您的个人数据安全。
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
API 任务管理 缺陷管理 规则管理
code_duplication_total 代码重复数。 非空非注释行连续10行相同的代码片段和import行(第三方机构标准),会被识别是重复代码。 说明: 代码重复数是过每个文件的重复代码行相加得出,而不是以重复代码明细结果里的代码片段相加。如:三个文件都有相同的10行重复代码,则代码重复数为30;如:
手动续费 在云服务控制台续费 登录管理控制台。 单击左侧导航栏的图标,选择“开发与运维 > 代码检查 CodeArts Check”。 在页面订单列表中,单击待续费订单右上角“续费”。 进入“续费”页面,根据续费时长,判断是否勾选“统一到期日”,将资源到期时间统一到各个月的某一天
查询任务执行状态 功能介绍 根据任务ID查询任务执行状态。任务状态:0表示检查中,1表示检查失败,2表示检查成功,3表示任务中止。只有正在检查中才有进度的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/progress 表1 路径参数
到期后影响 当您的代码检查服务套餐到期未续费,首先会进入宽限期,套餐将显示“已过期”。宽限期内,您可以正常访问代码检查服务。 如果您在宽限期内仍未续费代码检查服务套餐,那么就会进入保留期,套餐状态变为“冻结”。保留期内,您可以查看代码检查服务和删除代码检查任务。 华为云根据客
限制值 单次检查支持扫描的问题数量 一个代码检查任务支持扫描的问题数量最多为300000。 租户自定义规则集数(个) 租户可以自定义的规则集数最大为1000。 租户创建代码检查任务数(个) 租户下可以创建的总任务数最大为50000。 单次代码检查最大时长 12小时。 支持的自定义规则数量
应用:使用规则集对Web开发语言进行代码检视,并为开发角色提供修复建议,比如修改的代码位置、系统、语言、模块、引擎等。 场景特点:Web服务面向Internet互联网,容易遭受DDos攻击、信息泄露等风险。 适用场景:互联网服务交付安全等级验收。 项目质量控制 应用:在交付过程中实时根据代码复杂度、重复率、质量得分控制风险。
计费FAQ 旧版代码检查计费方式如何收费? 旧版本开通/关闭按需计费方式说明 已开通旧版代码检查服务,能否转换为新版本计费?
图1 自动续费配置 在云服务控制台开通自动续费 登录管理控制台。 单击左侧导航栏的图标,选择“开发与运维 > 代码检查 CodeArts Check”。 找到已购买的代码检查服务套餐记录,单击“自动续费”旁边“设置”。 选择续费时长,并根据需要设置自动续费次数,单击“确认”。 在续费管理页面开通自动续费
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。