检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
第三次正式发布。本次变更说明如下: 修改代码示例中代码仓库地址信息。 2020-03-13 第二次正式发布。本次变更说明如下: 代码检查API接口项增加变更说明,如有疑问,请在帮助页面下方提交反馈。 2020-01-03 第一次正式发布。 2019-12-28
删除自定义规则集 功能介绍 删除自定义规则集,正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查看规则集的规则列表 功能介绍 根据项目ID、规则集ID等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/ruleset/{ruleset_id}/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id
创建自定义规则集 功能介绍 可根据需求灵活的组合规则。 调用方法 请参见如何调用API。 URI POST /v2/ruleset 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token
API 任务管理 缺陷管理 规则管理
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
如何调用API 构造请求 认证鉴权 返回结果
修改任务规则集 查询任务检查失败日志 获取任务的目录树 任务配置屏蔽目录 查询任务的高级配置 任务配置高级配置 查询分支任务列表 父主题: API
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限,详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
帮助产品成功。 您可以使用本文档提供API对代码检查进行相关操作,如创建、删除、查询任务等。支持的全部操作请参见API概览。 在调用代码检查API之前,请确保已经充分了解代码检查基本概念。详细信息请参见产品介绍。 终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节
创建访问凭证AK和SK 创建调用API时使用的AK和SK。 下载KooCLI工具并获取代码检查API的调用命令 下载KooCLI工具并获取代码检查API的调用命令。 在Jenkins工具中调用代码检查API 通过Jenkins工具调用代码检查API。 创建代码检查任务所属项目 使用华为云账号登录华为云控制台页面。
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。
Cmetrics工具规格说明 工具介绍 Cmetrics是华为公司自研代码度量工具,通过扫描源码对各项指标进行度量。度量指标包括代码量、函数圈复杂度、文件代码行、函数代码行、文件重复、代码重复、危险函数、冗余代码等多项指标。当前工具版本为2.1.5。 参数说明 表1 参数说明 参数
历史趋势:默认展示近一个月内该代码检查任务的检查结果变化趋势,包括问题数、圈复杂度和重复率。 查看代码问题 可查看代码问题详情有两种查看方式:导出至本地和在线查看。 导出至本地。 方式一: 返回至代码检查任务列表页,勾选代码检查任务名称前的复选框,可选择的任务数为1~20。 选择“更多操作 > 导出任务告警”。
支持规则的搜索或过滤。 5 快速设置规则 支持规则的快速勾选/取消勾选。 6 导入/导出配置规则 将规则详情信息以xlsx格式的文件导出至本地。或将本地准备好的xlsx格式的规则文件导入至工具。 父主题: 参考