-
API - 代码检查 CodeArts Check
API 任务管理 缺陷管理 规则管理
-
API概览 - 代码检查 CodeArts Check
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括：新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括：问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括：获取规则列表接口、创建自定义规则集、查询规则集列表等。
-
如何调用API - 代码检查 CodeArts Check
如何调用API 构造请求 认证鉴权 返回结果
-
API类问题 - 代码检查 CodeArts Check
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
-
使用公共API时提示没有权限 - 代码检查 CodeArts Check
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限，详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决，请联系技术支持工程师。 父主题： API类问题
-
使用公用API时提示项目不存在 - 代码检查 CodeArts Check
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决，请联系技术支持工程师。 父主题： API类问题
-
构造请求 - 代码检查 CodeArts Check
resource-path 资源路径，即API访问路径，从具体API的URI模块获取。例如“理员创建IAM用户”API的resource-path为“/v3.0/OS-USER/users”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带
-
认证鉴权 - 代码检查 CodeArts Check
使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过
-
规则管理 - 代码检查 CodeArts Check
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 父主题： API
-
缺陷管理 - 代码检查 CodeArts Check
缺陷管理 查询缺陷概要 查询cmertrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题： API
-
任务管理 - 代码检查 CodeArts Check
任务配置检查参数 修改任务规则集 查询任务检查失败日志 获取任务的目录树 任务配置屏蔽目录 查询任务的高级选项 任务配置高级选项 父主题： API
-
查询缺陷概要 - 代码检查 CodeArts Check
查询缺陷概要 功能介绍 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_id
-
返回结果 - 代码检查 CodeArts Check
"error_code": "IAM.0011" } 其中，error_code表示错误码，error_msg表示错误描述信息。 父主题： 如何调用API
-
终止检查任务 - 代码检查 CodeArts Check
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID 请求参数 表2 请求Header参数
-
删除检查任务 - 代码检查 CodeArts Check
删除检查任务 功能介绍 删除检查任务，执行中的任务删除无法再查看 调用方法 请参见如何调用API。 URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header参数
-
新建检查任务 - 代码检查 CodeArts Check
新建检查任务 功能介绍 新建检查任务但是不执行。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 请求参数 表2 请求Header参数
-
查询缺陷详情 - 代码检查 CodeArts Check
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID 表2
-
任务配置高级选项 - 代码检查 CodeArts Check
任务配置高级选项 功能介绍 任务配置高级选项，如自定义镜像 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
-
查询cmertrics缺陷概要 - 代码检查 CodeArts Check
查询cmertrics缺陷概要 功能介绍 根据检查任务ID查询cmertrics缺陷概要。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/metrics-summary 表1 路径参数 参数 是否必选 参数类型
-
修改缺陷状态 - 代码检查 CodeArts Check
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务id 请求参数
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
