检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
"error_code": "IAM.0011" } 其中,error_code表示错误码,error_msg表示错误描述信息。 父主题: 如何调用API
修改任务规则集 查询任务检查失败日志 获取任务的目录树 任务配置屏蔽目录 查询任务的高级配置 任务配置高级配置 查询分支任务列表 父主题: API
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
用方法参考API接口说明文档手册。 查询缺陷详情的响应结果。 相关参考 本示例中所有接口均可在华为云OpenAPI调试平台进行对应调试。 新建代码检查任务的API接口说明可参考新建检查任务。 执行代码检查任务的API接口说明可参考执行检查任务。 查询任务执行状态的API接口说明可参考查询任务执行状态。
如何调用API 构造请求 认证鉴权 返回结果
新建检查任务 功能介绍 新建检查任务但是不执行。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID
删除检查任务 功能介绍 删除检查任务,执行中的任务删除无法再查看 调用方法 请参见如何调用API。 URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header参数
请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID
任务配置高级配置 功能介绍 任务配置高级配置,如自定义镜像 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询cmetrics缺陷概要 功能介绍 根据检查任务ID查询cmetrics缺陷概要。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/metrics-summary 表1 路径参数 参数 是否必选 参数类型 描述
查询分支任务列表 功能介绍 查询分支任务列表 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/branches 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每
历史扫描结果查询 功能介绍 提供每次扫描的问题数量统计 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/checkrecord 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
任务配置检查参数 功能介绍 任务配置检查参数 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-parameters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
任务配置屏蔽目录 功能介绍 任务配置屏蔽目录 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-ignorepath 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个Code
查询任务检查失败日志 功能介绍 查询任务检查失败日志,不传execute_id则查询最近一次的检查日志 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/log-detail 表1 路径参数 参数 是否必选 参数类型
查询任务的高级配置 功能介绍 查询任务的高级配置 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID
请参见如何调用API。 URI POST /v2/tasks/{task_id}/run 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID