检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。
错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。
API 任务管理 缺陷管理 规则管理
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
如何调用API 构造请求 认证鉴权 返回结果
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限,详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决,请联系技术支持工程师。 父主题: API
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户接口为例说明如何调用API。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987 。 请求URI 尽管请求URI
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需要使用一个
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值
查询缺陷概要 功能介绍 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_id
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck
新建检查任务 功能介绍 新建检查任务但是不执行。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1
删除检查任务 功能介绍 删除检查任务,执行中的任务删除无法再查看 调用方法 请参见如何调用API。 URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,