检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
应用示例 示例1：查询任务列表 示例2：查询缺陷概要
获取任务的目录树 功能介绍 获取任务的目录树 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/listpathtree 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目
创建代码检查任务 代码检查服务可检查不同代码仓的代码质量，在创建代码检查任务前，需满足以下条件： 已新建CodeArts项目。 如果使用的是代码托管服务（CodeArts Repo）的代码仓库，则可以参考代码托管服务的“用户指南 > 新建Repo代码仓库”，完成新建代码仓库。 如
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个C
查询任务检查失败日志 功能介绍 查询任务检查失败日志，不传execute_id则查询最近一次的检查日志 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/log-detail 表1 路径参数 参数 是否必选 参数类型
基本概念 表1 代码检查服务基本概念 词汇 定义 重复率 重复行数是指涉及至少一次重复的代码行数；重复块是指包含重复行的代码块（最小重复块定义：Java语言连续10行重复，其它语言10行中连续100个字符重复算一个重复块）；重复率=重复行/代码总行数（不包含空行与注释）。 规则
删除自定义规则集 功能介绍 删除自定义规则集，正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
示例2：查询缺陷概要 场景描述 本章节指导用户根据检查任务ID查询缺陷结果的概要，包括问题概述、问题状态、圈复杂度、代码重复率等。 约束限制 任务存在。 涉及接口 涉及的接口如下： 查询缺陷概要：查询缺陷概要，包括问题概述、问题状态、圈复杂度、代码重复率等。 操作步骤 接口相关信息
代码检查服务入门实践 当用户开通代码检查服务后，可以根据不同的业务场景灵活使用。 本文介绍常见的代码检查实践。 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例，介绍如何创建通用Git代码检查任务。
任务配置高级配置 功能介绍 任务配置高级配置，如自定义镜像 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
计费项 资源扩展计费说明 代码检查支持资源并发扩展，计费项为代码检查并发数。 表1 并发数计费 计费项 计费项说明 适用资源扩展类型 计费公式 代码检查并发数 某一Region内，租户中所有代码检查任务的并发执行数量总和。 代码检查并发扩展 单价*并发数*购买时长
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括：新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括：问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括：获取规则列表接口、创建自定义规则集、查询规则集列表等。
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
任务配置屏蔽目录 功能介绍 任务配置屏蔽目录 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-ignorepath 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
什么是代码检查 代码检查（CodeArts Check）是基于云端实现的代码检查服务。建立在多年自动化源代码静态检查技术积累与企业级应用经验的沉淀之上，为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力，提供全面质量报告、便捷闭环处理问题，帮助企业有效管控代码质量，助力企业成功。
查询缺陷详情的统计 功能介绍 根据检查任务ID查询缺陷详情的统计 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-statistic 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务I
修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下： 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下： 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置。
任务配置检查参数 功能介绍 任务配置检查参数 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-parameters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
执行检查任务 功能介绍 执行检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/run 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个CodeArts
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，每个Code
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
