检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取规则列表接口 功能介绍 根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity
获取任务的目录树 功能介绍 获取任务的目录树 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/listpathtree 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目
查询规则集列表-V3 功能介绍 根据项目ID、语言等条件查询规则集列表，与V2接口相比，限制了分页参数大小，V2接口后续将下线。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询规则集列表 功能介绍 根据项目ID、语言等条件查询规则集列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，每个Code
CodeArts Check最佳实践汇总 本文汇总了基于代码检查服务（CodeArts Check）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松检查代码。 表1 CodeArts Check最佳实践一览表 最佳实践 说明 使用预置规则检查GitCode代码仓中的代码质量
查看规则集的规则列表 功能介绍 根据项目ID、规则集ID等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/ruleset/{ruleset_id}/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id
配置代码检查任务消息通知 您可以根据实际需求，设置代码检查任务事件类型的通知方式。 例如，当检查任务的门禁失败时，可以设置以服务动态或邮件方式通知用户，并可配置通知的接收者角色和自定义成员。若不配置接收者角色及成员，门禁失败时向任务执行者发送通知；若配置，则向任务执行者、配置的接收者角色以及自定义成员发送通知。
查询缺陷概要 功能介绍 根据检查任务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 任务ID，即新
查询cmetrics缺陷概要 功能介绍 根据检查任务ID查询cmetrics缺陷概要。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/metrics-summary 表1 路径参数 参数 是否必选 参数类型 描述
删除自定义规则集 功能介绍 删除自定义规则集，正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个C
删除检查任务 功能介绍 删除检查任务，执行中的任务删除无法再查看 调用方法 请参见如何调用API。 URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header参数
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，每个Code
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID
查看代码检查结果 前提条件 您已创建并执行代码检查任务。 查看代码检查详情 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面，搜索目标任务。在任务列表页，可以查看检查任务的状态。 新问题：表示本次代码检查任务执行后新增的问题。 未解决：表示该代码检查任务未解决的问题。
执行检查任务 功能介绍 执行检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/run 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个CodeArts
任务配置高级配置 功能介绍 任务配置高级配置，如自定义镜像 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
任务配置屏蔽目录 功能介绍 任务配置屏蔽目录 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-ignorepath 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
