检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括：新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括：问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括：获取规则列表接口、创建自定义规则集、查询规则集列表等。
eck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数 参数 是否必选 参数类型 描述 execute_id 否 String 任务单次的执行ID 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type
Check服务页面的导航栏选择“设置 > 通用设置 > 服务扩展点管理”。 单击“新建服务扩展点”，在下拉列表中选择“通用Git”。 在弹框中配置以下信息，单击“确定”。 表2 新建通用Git服务扩展点 参数 说明 连接名称 自定义，支持中文、英文、数字、“-”、“_”、“.”、空
单击“关闭”。 图1 新建代理 根据“步骤三”提示，在弹性云服务器列表页，单击前提准备中购买的服务器所在行的“远程登录”按钮，执行6中复制的命令。 在代理列表页面，单击“刷新列表”，后台自动同步信息后，代理列表中会增加一条代理执行机信息。代理执行机的代理别名为“agent_tes
在项目下的CodeArts Check服务页面的导航栏选择“设置 > 通用设置 > 服务扩展点管理”。 单击“新建服务扩展点”，在下拉列表中选择“GitCode”。 参考表2在弹框中配置参数。 表2 GitCode服务扩展点参数说明 参数 说明 连接名称 服务扩展点的名称，可自定义。例如：GitCode。
单击“已包含语言”之后的图标，重新获取代码仓库语言，刷新后的列表新增了多种语言。 如果页面中已显示“PYTHON”，则忽略此步骤。 将PYTHON语言对应的开关打开。 在弹框中单击“确定”。 执行任务。 单击“开始检查”，启动任务。 当页面显示，表示任务执行成功。 如果任务执行失败，请根据页面弹出报错提示排查修改。
warning_suppression_total 抑制告警数。 统计被扫描文件的告警抑制语句出现的数量。注释中的字符串符合特定正则表达式，则会被认为是告警抑制语句。不同语言对应的正则表达式请参考表5。 该参数需启用Cmetrics规则后生效。 warning_suppression_kloc 抑制告警密度。
第二十二次正式发布。本次变更说明如下： 修改查询任务的已选规则集列表v3。 修改查询任务规则集的检查参数v3。 修改错误码。 2022-09-22 第二十一次正式发布。本次变更说明如下： 修改错误码。 2022-09-06 第二十次正式发布。本次变更说明如下： 修改示例1：查询任务列表。 修改示例2：查询缺陷概要。
Setting面板”，单击提示下方链接打开底部Setting面板查看配置。 “CodeArts Check配置”界面功能说明请参见图1和表1。 图1 CodeArts Check配置界面 表1 CodeArts Check配置界面功能说明 序号 功能项 功能描述 1 开启/关闭无感扫描和git提交自动扫描
单击“确定”，进入到“规则集配置”页面。 勾选创建自定义规则中创建的规则，单击右上角“保存”。 创建代码检查任务 在代码检查任务列表页，单击“新建任务”，按照如下表格配置参数。 表3 代码检查任务参数说明 参数 说明 归属项目 创建代码检查任务所属项目中创建的项目名称“Scrum01”。默认填写，无需配置。
efects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数 参数 是否必选
基于项目入口访问CodeArts Check服务首页。 进入代码检查页面，在任务列表中，单击任务名称。 进入“代码检查详情”页面，选择“设置 > 集成服务 > CodeArts Repo”。 选择是否勾选“MR检查状态”，勾选即表示开启代码评审（MR）的自动化检查。 当所在任务的代码仓库中有分支
/v2/tasks/{task_id}/progress “task_id”中填入MR任务ID以查询任务执行状态，任务状态0表示检查中，1表示检查失败，2表示检查成功，3表示任务中止。 轮询任务执行状态的返回结果。 查询缺陷详情 查询缺陷详情请求示例。 ShowTaskDefects：GET
检查任务列表可查看对应仓库的检查任务。 以下示例为在代码托管服务中创建云端仓库不勾选“自动创建代码检查任务”时，Repo代码源代码检查任务的创建步骤。 基于项目入口访问CodeArts Check服务首页。 在代码检查页面，单击“新建任务”，在“新建任务”页面，参考表1配置参数。
200 表6 响应Body参数 参数 参数类型 描述 task_id String 检查任务id 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数
一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 响应参数 状态码： 200 表3 响应Body参数 参数
cts-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数
Check服务页面的导航栏选择“设置 > 通用设置 > 服务扩展点管理”。 单击“新建服务扩展点”，在下拉列表中选择“通用Git”。 在弹框中配置以下信息，单击“确定”。 表2 新建通用Git服务扩展点 参数 说明 连接名称 自定义，支持中文、英文、数字、“-”、“_”、“.”、空
应用示例 示例1：查询任务列表 示例2：查询缺陷概要
一的任务ID 表2 Query参数 参数 是否必选 参数类型 描述 current_path 否 String 目录或文件的路径 offset 否 Integer 分页索引，偏移量 limit 否 Integer 每页显示的数量,每页最多显示1000条 请求参数 表3 请求Header参数
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
