检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
CodeArts Check插件使用指南(IntelliJ IDEA版本) 本插件致力于守护开发人员代码质量,成为开发人员的助手和利器。秉承极简、极速、即时看护的理念,提供业界规范的检查、代码风格一键格式化及代码自动修复功能。 安装CodeArts Check插件 在IDEA IDE
访问CodeArts Check服务首页 使用华为云账号登录华为云控制台页面。 单击页面左上角,在服务列表中选择“开发与运维 > 代码检查 CodeArts Check”。 代码检查服务页面有两种访问方式:首页入口和项目入口。 首页入口 单击“立即使用”,进入代码检查服务首页。
修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下: 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下: 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置
String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户
偏移量,非必填 limit 否 Integer 每页显示的数量,非必填 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token通过调用IAM服务获取用户
是否必选 参数类型 描述 language 是 String 规则集语言 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户
否 String 过滤开始时间,根据任务检查开始时间过滤 end_time 否 String 过滤结束时间,根据任务检查结束时间过滤 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户
示例2:查询缺陷概要 场景描述 本章节指导用户根据检查任务ID查询缺陷结果的概要,包括问题概述、问题状态、圈复杂度、代码重复率等。 约束限制 任务存在。 涉及接口 涉及的接口如下: 查询缺陷概要:查询缺陷概要,包括问题概述、问题状态、圈复杂度、代码重复率等。 操作步骤 接口相关信息
描述 execute_id 否 String 任务单次的执行ID 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户
只查询其他用户自定义规则集,'0,1,2'或''查所有' offset 否 Integer 分页索引,偏移量 limit 否 Integer 每页显示的数量 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户
示例1:查询任务列表 场景描述 本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 约束限制 无。 涉及接口 涉及的接口如下: 查询任务列表:根据DEVCLOUD_PROJECT_UUID查询任务列表。 操作步骤 查询任务列表。 接口相关信息 URI
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
参数类型 描述 offset 否 Integer 分页索引,偏移量 limit 否 Integer 每页显示的数量,每页最多显示100条 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户
String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户
String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户
URI POST /v2/ruleset 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取
获取任务的目录树 功能介绍 获取任务的目录树 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/listpathtree 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID