检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括：新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括：问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括：获取规则列表接口、创建自定义规则集、查询规则集列表等。
代码检查服务提供丰富的API接口、涵括任务新建、任务设置、任务扫描、任务报告解析等检查业务全流程，支持用户使用接口方式无缝集成到自建CI/CD或者CodeArts，作业数据灵活对接到客户看板，代码质量可视、可管理。
获取规则列表接口 功能介绍 根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity
支持五大业界主流标准和华为编程规范 支持五大业界主流标准和华为编程规范，提升产品代码规范度 软件产品的质量问题往往导致产品产生不可接受的运营风险或过度成本，因此在源代码级别建立质量检测措施的标准是非常重要的，业界如ISO/IEC 5055标准、CERT编程规范等。 使用代码检查服务
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
新建代码检查任务的API接口说明可参考新建检查任务。 执行代码检查任务的API接口说明可参考执行检查任务。 查询任务执行状态的API接口说明可参考查询任务执行状态。
如何调用API 构造请求 认证鉴权 返回结果
API 任务管理 缺陷管理 规则管理
身份认证与访问控制 身份认证 用户访问代码检查服务的方式有多种，包括代码检查用户界面、API、SDK，无论访问方式封装成何种形式，其本质都是通过代码检查提供的REST风格的API接口进行请求。 代码检查的接口需要经过认证请求后才可以访问成功。
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题： API
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限，详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决，请联系技术支持工程师。 父主题： API
构造请求 本节介绍REST API请求的组成，并以调用IAM服务的管理员创建IAM用户接口为例说明如何调用API。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987 。 请求URI 尽管请求URI
本次变更说明如下： 代码检查API接口项增加变更说明，如有疑问，请在帮助页面下方提交反馈。 2020-01-03 第一次正式发布。 2019-12-28
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题： API
认证鉴权 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 Token认证：通过Token认证通用请求。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时，需要使用一个
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决，请联系技术支持工程师。 父主题： API类问题
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求消息头
执行代码检查任务时提示：Cppcheck cannot tokenize the code correctly 问题现象 代码检查提示“Cppcheck cannot tokenize the code correctly”。 原因分析 是Cppcheck的一条检查规则，在代码里面有语法错误
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
