检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 任务管理 缺陷管理 规则管理
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限,详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
当使用Token方式认证时,必须填充该字段。用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 X-Project-ID:子项目ID,可选,在多项目场景中使用。如果云服务资源创建在子项目中,AK/SK认证方式下,操作该资源的接口调用需要在请求消息头中携带X-Project-ID。
使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过
修改任务规则集 查询任务检查失败日志 获取任务的目录树 任务配置屏蔽目录 查询任务的高级配置 任务配置高级配置 查询分支任务列表 父主题: API
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
缺陷管理 查询缺陷概要 查询cmertrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务id 请求参数
旧版代码检查计费方式如何收费? 本章节仅供老用户参考。 代码检查服务依赖需求管理服务,开通前请先开通需求管理服务。 服务的开通需要区分区域,因此开通前注意选择自己需要开通的区域。 服务开通后,需注意创建的资源也分区域。 例如,在“华北-北京四”中创建了“项目A”,在下次查看“项目
查询缺陷概要 功能介绍 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_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-ignorepath 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
任务配置检查参数 功能介绍 任务配置检查参数 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-parameters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于管理员创建IAM用户接口,返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头
旧版本开通/关闭按需计费方式说明 本章节仅供老用户参考。 CodeArts旧版计费包括包年/包月套餐购买及服务组合开通方式。 也可单独开通代码检查服务。单独开通的计费方式请参见旧版代码检查计费方式如何收费?。 前提条件 请先注册华为账号并开通华为云(如果华为云账号已注册并开通华为
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID 请求参数 表2 请求Header参数