检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置代码检查任务集成服务 当代码托管中有分支合并时,在代码检查服务中可以设置自动检查代码检查任务,并生成一个子任务,即代码仓库中有分支合并,就会重新生成一个代码检查子任务。 配置MR检查状态 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称
配置代码检查任务自定义环境 当使用代码检查服务时,若常用的编译构建环境缺少您需要的依赖包、工具,无法满足您的使用需求时,您可通过自定义构建环境提供的基础镜像执行代码检查任务。 前提条件 已将自定义环境推送到镜像仓中,具体操作请参见制作镜像并推送到SWR仓库。 配置自定义镜像 基于项目入口访问
配置代码检查任务消息通知 您可以根据实际需求,设置代码检查任务事件类型的通知方式。 例如,当检查任务的门禁失败时,可以设置以服务动态或邮件方式通知用户,并可配置通知的接收者角色和自定义成员。若不配置接收者角色及成员,门禁失败时向任务执行者发送通知;若配置,则向任务执行者、配置的接收者角色以及自定义成员发送通知
配置代码检查任务定时执行 根据实际需要,设置代码检查任务的执行计划,定时执行默认分支的检查任务。 建议在非流水线使用情况下进行配置。 配置当天时间间隔必须在5分钟以上。 配置执行计划 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称
身份认证与访问控制 身份认证 用户访问代码检查服务的方式有多种,包括代码检查用户界面、API、SDK,无论访问方式封装成何种形式,其本质都是通过代码检查提供的REST风格的API接口进行请求。 代码检查的接口需要经过认证请求后才可以访问成功。代码检查支持两种认证方式: Token认证
配置代码检查任务预置规则集 规则集则是一组用于做代码检查的规则组成的集合。一般根据不同的检查目标和需求,规则集也有相应的分类,比如对安全类、安卓应用、编程风格,使用这些类别进行检查的时候,规则集内的规则也会有所不同。 用户可根据实际需要更换代码检查任务使用的规则集,新启用的规则集将在下一次执行检查时生效
配置代码检查任务自定义规则集 代码检查服务除了可以使用预置规则集类型,用户还可以根据实际需要自定义代码检查规则集,每个规则集中最少设置一条规则。 目前仅支持配置单语言的规则集,即一种规则集只能配置同一种语言类型的检查规则。 代码检查规则集提供了代码安全检查增强包功能,使用前请务必按需购买
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题
查询任务的已选规则集列表v3 功能介绍 查询任务的已选规则集列表v3。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询任务的已选规则集列表v2 功能介绍 查询任务的已选规则集列表v2。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询任务的高级配置 功能介绍 查询任务的高级配置 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID
使用前必读 欢迎使用代码检查服务(CodeArts Check)。代码检查是基于云端实现代码质量管理的服务,软件开发者可在编码完成后执行多语言的代码静态检查和安全检查,获取全面的质量报告,并提供缺陷的分组查看与改进建议,有效管控代码质量,帮助产品成功。 您可以使用本文档提供API对代码检查进行相关操作
查询分支任务列表 功能介绍 查询分支任务列表 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/branches 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID task_id
查询任务规则集的检查参数v2 功能介绍 查询任务规则集的检查参数v2 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters 表1 路径参数 参数
历史扫描结果查询 功能介绍 提供每次扫描的问题数量统计 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/checkrecord 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询任务执行状态 功能介绍 根据任务ID查询任务执行状态。任务状态:0表示检查中,1表示检查失败,2表示检查成功,3表示任务中止。只有正在检查中才有进度的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/progress 表1 路径参数
查询缺陷详情的统计 功能介绍 根据检查任务ID查询缺陷详情的统计 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-statistic 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID
查询规则集列表 功能介绍 根据项目ID、语言等条件查询规则集列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query
查询任务检查失败日志 功能介绍 查询任务检查失败日志,不传execute_id则查询最近一次的检查日志 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/log-detail 表1 路径参数 参数 是否必选 参数类型
查询规则集列表-V3 功能介绍 根据项目ID、语言等条件查询规则集列表,与V2接口相比,限制了分页参数大小,V2接口后续将下线。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id