CLI命令参考
任务管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 新建检查任务 | hcloud CodeArtsCheck CreateTask | 新建检查任务但是不执行。 | |
| 删除检查任务 | hcloud CodeArtsCheck DeleteTask | 删除检查任务，执行中的任务删除无法再查看 | |
| 查询任务列表 | hcloud CodeArtsCheck ShowTaskListByProjectId | 根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 | |
| 执行检查任务 | hcloud CodeArtsCheck RunTask | 执行检查任务。 | |
| 终止检查任务 | hcloud CodeArtsCheck StopTaskById | 根据任务ID终止检查任务。 | |
| 查询任务执行状态 | hcloud CodeArtsCheck ShowProgressDetail | 根据任务ID查询任务执行状态。任务状态：0表示检查中，1表示检查失败，2表示检查成功，3表示任务中止。只有正在检查中才有进度的详细信息。 | |
| 历史扫描结果查询 | hcloud CodeArtsCheck CheckRecord | 提供每次扫描的问题数量统计 | |
| 查询任务的已选规则集列表 | hcloud CodeArtsCheck ListTaskRuleset | 查询任务的已选规则集列表。 | |
| 查询任务的已选规则集列表 | hcloud CodeArtsCheck ShowTasksRulesets | 查询任务的已选规则集列表。 | |
| 查询任务规则集的检查参数 | hcloud CodeArtsCheck CheckParameters | 查询任务规则集的检查参数 | |
| 查询任务规则集的检查参数 | hcloud CodeArtsCheck CheckRulesetParameters | 查询任务规则集的检查参数 | |
| 任务配置检查参数 | hcloud CodeArtsCheck ListTaskParameter | 任务配置检查参数 | |
| 获取任务的目录树 | hcloud CodeArtsCheck ShowTaskPathTree | 获取任务的目录树 | |
| 任务配置屏蔽目录 | hcloud CodeArtsCheck UpdateIgnorePath | 任务配置屏蔽目录 | |
| 查询任务的高级选项 | hcloud CodeArtsCheck ShowTaskSettings | 查询任务的高级选项 | |
| 任务配置高级选项 | hcloud CodeArtsCheck UpdateTaskSettings | 任务配置高级选项，如自定义镜像 | |
| 修改任务规则集 | hcloud CodeArtsCheck UpdateTaskRuleset | 修改任务规则集。 | |
| 查询任务检查失败日志 | hcloud CodeArtsCheck ShowTasklog | 查询任务检查失败日志，不传execute_id则查询最近一次的检查日志 |
缺陷管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询缺陷概要 | hcloud CodeArtsCheck ShowTaskDetail | 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 | |
| 查询cmertrics缺陷概要 | hcloud CodeArtsCheck ShowTaskCmetrics | 根据检查任务ID查询cmertrics缺陷概要。 | |
| 查询缺陷详情 | hcloud CodeArtsCheck ShowTaskDefects | 根据检查任务ID分页查询缺陷结果详情。 | |
| 查询缺陷详情的统计 | hcloud CodeArtsCheck ShowTaskDefectsStatistic | 根据检查任务ID查询缺陷详情的统计 | |
| 修改缺陷状态 | hcloud CodeArtsCheck UpdateDefectStatus | 修改检查出的缺陷的状态为已解决、已忽略 |
规则管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取规则列表接口 | hcloud CodeArtsCheck ListRules | 根据语言、问题级别等条件查询规则列表。 | |
| 创建自定义规则集 | hcloud CodeArtsCheck CreateRuleset | 可根据需求灵活的组合规则。 | |
| 查询规则集列表 | hcloud CodeArtsCheck ListRulesets | 根据项目ID、语言等条件查询规则集列表。 | |
| 查看规则集的规则列表 | hcloud CodeArtsCheck ListTemplateRules | 根据项目ID、规则集ID等条件查询规则列表。 | |
| 删除自定义规则集 | hcloud CodeArtsCheck DeleteRuleset | 删除自定义规则集，正在使用中的或默认规则集不能删除 | |
| 设置每个项目对应语言的默认规则集配置 | hcloud CodeArtsCheck SetDefaulTemplate | 设置每个项目对应语言的默认规则集配置。 |
