文档首页/ 代码检查 CodeArts Check/ API参考/ 修订记录
更新时间：2026-02-02 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修订记录

文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。

修订记录

发布日期

第二十次正式发布。本次变更说明如下：

新增接口：

  • 根据ID查询Task - GetTaskInfoByID。
  • -执行全量检查 - CreateJob。
  • 根据任务类型获取检查列表 - ShowCheckList。
  • 新建检查任务V3 - CreateTaskV3。
  • 查询日志 - ShowLog、载日志文件 - DownloadLog。
  • 查询单个问题详情和上下文代码 - GetSingleDefect。
  • 获取代码度量文件列表V2 - GetMeasureListV2。
  • 查询代码问题概览 - GetTaskStatistics。

2026-02-01

第十九次正式发布。本次变更说明如下：

新增接口：

  • 查询编译前执行的shell脚本 - ShowPortalServicePreCheckScript。
  • 删除任务 - DeleteTaskV3。
  • 查询任务列表 - ShowTasksList。
  • 查询指定代码检查任务的基本配置信息 - GetSimpleQueryConfigTemplate。
  • 查询规则集列表-V2 - ListAllCriterionSets。
  • 规则查询过滤器 - ShowFilter、查询规则列表-V2 - ListCriterion。
  • 获取代码问题列表 - IssueListByFilter。
  • 获取代码问题统计 - IssueFilter。
  • 查询问题和度量趋势 - DisplayTrend。
  • 查询问题状态修改的所有情形 - NextStatus。
  • 修改任务配置 - ModifyPipelineTaskV2。

2025-10-30

第十八次正式发布。本次变更说明如下：

新增接口：

  • 生成PDF报告 - PutPdfJob。
  • 查询异步任务进度 - GetAsyncJob。
  • 下载PDF报告 - GetPdfFile。
  • 获取代码度量文件列表 - GetMeasureList。
  • 查询重复代码块信息 - GetRelatedDuplicateBlocks。

2025-05-21

第十七次正式发布。本次变更说明如下：

新增接口：

  • 获取任务的目录树 - ShowTaskPathTree。
  • 任务配置屏蔽目录 - UpdateIgnorePath。
  • 查询任务的高级配置 - ShowTaskSettings。
  • 任务配置高级配置 - UpdateTaskSettings。

2024-3-26

第十六次正式发布。本次变更说明如下：

修改接口：

  • 查询任务的已选规则集列表v3 - ShowTasksRulesets。
  • 查询任务规则集的检查参数v3 - CheckRulesetParameters。

修改错误码。

2023-09-22

第十五次正式发布。本次变更说明如下：

  • 修改示例1章节：查询任务列表。
  • 修改示例2章节：查询缺陷概要。

2023-08-29

第十四次正式发布。本次变更说明如下：

修改接口：

  • 修改查询缺陷概要 - ShowTaskDetailV2。
  • 修改获取规则列表接口 - ListRules。

2023-06-30

第十三次正式发布。本次变更说明如下：

新增接口：

  • 查询任务检查失败日志 - ShowTasklog。
  • 删除自定义规则集 - DeleteRuleset。
  • 设置每个项目对应语言的默认规则集配置 - SetDefaulTemplate。

修改接口：

  • 新建检查任务 - CreateTaskV2。
  • 查询缺陷概要 - ShowTaskDetailV2。
  • 创建自定义规则集 - CreateRuleset。
  • 查看规则集的规则列表 - ListTemplateRules。

修改错误码章节。

2023-01-27

第十二次正式发布。本次变更说明如下：

  • 修改错误码章节。

2023-01-04

第十一次正式发布。本次变更说明如下：

新增接口：

  • 配置任务检查参数 - ListTaskParameter。
  • 查询代码度量概要 - ShowTaskCmetrics。
  • 查看规则集的规则列表 - ListTemplateRules。

2023-12-27

第十次正式发布。本次变更说明如下：

  • 增加规则管理章节。

2023-11-27

第九次正式发布。本次变更说明如下：

新增接口：

  • 删除检查任务 - DeleteTask。
  • 查询缺陷详情的统计 - ShowTaskDefectsStatisticV2。
  • 修改缺陷状态 - UpdateDefectStatus。

2023-09-29

第八次正式发布。本次变更说明如下：

修改任务管理章节和缺陷管理章节的接口。

2022-11-23

第七次正式发布。本次变更说明如下：

修改场景化示例章节：

  • 示例1：查询任务列表。
  • 示例2：查询缺陷概要。

2022-11-05

第六次正式发布。本次变更说明如下：

  • 修改构造请求章节。
  • 修改认证鉴权章节。

2022-08-06

第五次正式发布。本次变更说明如下：

增加场景化示例章节：

  • 示例1：查询任务列表。
  • 示例2：查询缺陷概要。

2022-07-30

第四次正式发布。本次变更说明如下：

  • 修改“请求示例”中URL地址信息。
  • 修改终端节点。

2022-07-10

第三次正式发布。本次变更说明如下：

修改代码示例中代码仓库地址信息。

2022-05-10

第二次正式发布。本次变更说明如下：

代码检查改成新的服务名称（CodeArts Check）。

2022-04-23

第一次正式发布。

2022-09-30