检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
打开华为云网站。 单击“注册”,根据提示信息完成注册。 注册成功后,系统会自动跳转至您的个人信息界面。 参考实名认证完成个人或企业账号实名认证。 购买CodeArts Check须知 在CodeArts支持的区域内,各区域独立开通/购买、独立计费。
不上传代码到云服务的情况下使用代码检查服务 应用场景 部分用户的代码有严格的保密机制,不允许将代码上传到外部网络,用户希望仅在信任的自有执行机上完成代码扫描服务。华为云CodeArts Check为此提供本实践的扫描方案,在不上传代码到云服务的情况下使用代码检查服务检查代码问题。
查询规则集列表-V3 功能介绍 根据项目ID、语言等条件查询规则集列表,与V2接口相比,限制了分页参数大小,V2接口后续将下线。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id
配置代码检查任务定时执行 根据实际需要,设置代码检查任务的执行计划,定时执行默认分支的检查任务。 建议在非流水线使用情况下进行配置。 约束与限制 配置当天时间间隔必须在5分钟以上。 配置执行计划 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中
不支持 支持 跨站脚本攻击(XSS) 支持 支持 攻击者利用在网站、电子邮件中的链接插入恶意代码,盗取用户信息。 不支持 支持 LDAP注入 支持 支持 利用用户输入的参数生成非法LDAP查询,盗取用户信息。
包年/包月 包年/包月套餐说明 代码检查服务采用包年/包月、并发扩展计费模式,提供基础版、专业版套餐,以满足不同规模用户的使用需求。并支持安全增强能力、并发扩展能力叠加。 不同版本套餐中,提供的功能特性及资源规格略有不同,详情请参见表1。 代码检查资源扩展包:在CodeArts或CodeArts
查询规则集列表 功能介绍 根据项目ID、语言等条件查询规则集列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts
前提条件 已注册华为云并实名认证,如果还没有华为账号,请参考以下步骤创建。 打开华为云网站。 单击“注册”,根据提示信息完成注册。 注册成功后,系统会自动跳转至您的个人信息界面。 参考实名认证完成个人或企业账号实名认证。
查看规则集的规则列表 功能介绍 根据项目ID、规则集ID等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/ruleset/{ruleset_id}/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id
表1 代码检查的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京四 cn-north-4 codecheck-ext.cn-north-4.myhuaweicloud.com 华北-北京一 cn-north-1 codecheck-ext.cn-north-1.myhuaweicloud.com
在“自定义镜像”中,输入以“域名称/组织名称/仓名称:tag名称”格式的内容或容器镜像服务SWR内镜像链接。 完成后,单击“保存”。 配置私有依赖仓扩展点 您可通过配置私有依赖库作为私有依赖下载源。
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts
Endpoint 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点中获取。 例如IAM服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。
CodeArts Check通过调用API执行MR增量检查 应用场景 在用户实际的使用场景中,用户往往有构建自己的代码质量管控平台,集成代码检查及其他检查项的需求。并且在用户的应用场景中,MR合入过程中的质量监控是一个高频应用场景。 本示例介绍如何通过调用CodeArtsCheck
查看徽标状态 执行完代码检查任务后,您可通过徽标状态查看代码健康度,并标识在代码仓库中。 代码检查服务中设置各个告警级别的影响度如下: 致命:5 严重:3 一般:1 提示:0.1 健康度=SUM ∑(告警数量*告警级别影响度)/代码量,各个健康度对应的标识如下: A:健康度<=0.001
使用自定义执行机执行代码检查任务 应用场景 当CodeArts Check提供的内置执行机不满足业务要求时,您可接入自行提供的执行机,通过注册的方式托管到CodeArts Check服务中,委托CodeArts Check服务进行调度并执行代码检查任务。
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值
查询缺陷详情的统计 功能介绍 根据检查任务ID查询缺陷详情的统计 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-statistic 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID