检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
Check代码检查插件(Cloud IDE版本)使用指南。 代码安全检查增强包介绍 华为代码安全检查增强包里安全检查能力作为深度价值特性,能深度识别代码中安全风险和漏洞,提供了套餐包内规则不覆盖的安全类场景,比如数值错误、加密问题、数据验证问题等。针对业界的安全漏洞检测项提供了更深入的
API 任务管理 缺陷管理 规则管理
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
修改任务规则集 查询任务检查失败日志 获取任务的目录树 任务配置屏蔽目录 查询任务的高级配置 任务配置高级配置 查询分支任务列表 父主题: API
如何调用API 构造请求 认证鉴权 返回结果
使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
扫描Shell语言代码时,度量结果不支持圈复杂度计算。 单击文件名称进入文件详情页面,单击可进入到对应的代码仓修改代码。 重复率:代码检查服务通过重复块、重复行、重复率来识别被测代码的重复情况。 修改重复率问题操作指导如下: 单击文件名称进入文件详情页面。 文件详情页面左侧的竖线标识了重复的代码块,单击标识竖线,将会显示与该段代码重复的文件列表。
也可以通过其他接口查询概要等信息,更多使用方法参考API接口说明文档手册。 查询缺陷详情的响应结果。 相关参考 本示例中所有接口均可在华为云OpenAPI调试平台进行对应调试。 新建代码检查任务的API接口说明可参考新建检查任务。 执行代码检查任务的API接口说明可参考执行检查任务。
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限,详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
帮助产品成功。 您可以使用本文档提供API对代码检查进行相关操作,如创建、删除、查询任务等。支持的全部操作请参见API概览。 在调用代码检查API之前,请确保已经充分了解代码检查基本概念。详细信息请参见产品介绍。 终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节
第三次正式发布。本次变更说明如下: 修改代码示例中代码仓库地址信息。 2020-03-13 第二次正式发布。本次变更说明如下: 代码检查API接口项增加变更说明,如有疑问,请在帮助页面下方提交反馈。 2020-01-03 第一次正式发布。 2019-12-28
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。