检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询缺陷概要 功能介绍 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_id
查询缺陷详情 功能介绍 根据检查任务ID分页查询任务检查结果的缺陷列表。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数解释
生成PDF报告 功能介绍 生成PDF报告,创建一个生成PDF的异步任务。 调用方法 请参见如何调用API。 URI PUT /v1/tasks/{task_id}/pdf-async-job 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数解释
下载PDF报告 功能介绍 根据查询异步任务接口返回的jobFile路径,下载对应的PDF报告,不可重复下载 调用方法 请参见如何调用API。 URI GET /v1/tasks/{task_id}/pdf-file 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是
约束限制: 只能选择当前系统上支持的语言。 取值范围: 只能传一种语言。
身份认证与访问控制 身份认证 用户访问代码检查服务的方式有多种,包括代码检查用户界面、API、SDK,无论访问方式封装成何种形式,其本质都是通过代码检查提供的REST风格的API接口进行请求。 代码检查的接口需要经过认证请求后才可以访问成功。代码检查支持两种认证方式: Token认证
删除检查任务 功能介绍 删除检查任务,任务删除后无法再查看。 调用方法 请参见如何调用API。 URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数解释: 任务ID,即新建检查任务接口的返回值
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck
查询异步任务进度 功能介绍 根据生成PDF报告接口返回的asyncJobId,查询生成PDF的进度 调用方法 请参见如何调用API。 URI GET /v1/tasks/{task_id}/async-job/{async_job_id} 表1 路径参数 参数 是否必选 参数类型
配置任务检查参数 功能介绍 基于规则集配置对应的任务配置检查参数 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-parameters 表1 路径参数 参数 是否必选 参数类型 描述 project_id
历史扫描结果查询 功能介绍 查询某个任务在时间范围内每次扫描各个问题级别的问题数量。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/checkrecord 表1 路径参数 参数 是否必选 参数类型 描述 task_id
任务配置屏蔽目录 功能介绍 任务配置屏蔽目录。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-ignorepath 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
修改任务配置 功能介绍 修改任务配置,支持用户从Gitee仓切换到GitCode仓 调用方法 请参见如何调用API。 URI PUT /v2/pipeline-task/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,
获取任务详情 功能介绍 根据任务ID获取任务详情 调用方法 请参见如何调用API。 URI GET /v4/tasks/{task_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID 表2 Query参数 参数 是否必选 参数类型
查询缺陷详情的统计 功能介绍 根据检查任务ID查询问题详情的统计 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-statistic 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数解释
CodeArts Check通过调用API执行MR增量检查 应用场景 在用户实际的使用场景中,用户往往有构建自己的代码质量管控平台,集成代码检查及其他检查项的需求。并且在用户的应用场景中,MR合入过程中的质量监控是一个高频应用场景。 本示例介绍如何通过调用CodeArtsCheck
查询任务检查失败日志 功能介绍 查询任务检查失败日志,不传execute_id则查询最近一次的检查日志。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/log-detail 表1 路径参数 参数 是否必选 参数类型
一站式问题闭环修复 一站式问题闭环修复,问题修复效率倍增 开发团队实施代码检查活动时通常遇到问题分析和修复成本高(工具问题不易理解、问题分到具体开发人员费时费力、多版本情况下重复处理同一告警令开发人员厌倦工具)导致落地困难,这些原因很大程度影响了开发人员对检查工具的使用积极性。 代码检查服务提供问题分析处理三大能力
任务配置高级配置 功能介绍 任务配置高级配置,如自定义镜像 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
CodeArts Check插件使用指南(IntelliJ IDEA版本) 本插件致力于守护开发人员代码质量,成为开发人员的助手和利器。秉承极简、极速、即时看护的理念,提供业界规范的检查、代码风格一键格式化及代码自动修复功能。 安装CodeArts Check插件 在IDEA IDE