检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括：新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括：问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括：获取规则列表接口、创建自定义规则集、查询规则集列表等。
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
API 任务管理 缺陷管理 规则管理
如何调用API 构造请求 认证鉴权 返回结果
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限，详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决，请联系技术支持工程师。 父主题： API类问题
修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十六次正式发布。本次变更说明如下： 增加修改任务配置。 2025-03-25 第二十五次正式发布。本次变更说明如下： 增加Cmetrics工具规格说明。 2024-09-30
续费 续费概述 手动续费 自动续费
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决，请联系技术支持工程师。 父主题： API类问题
修改任务规则集 查询任务检查失败日志 获取任务的目录树 任务配置屏蔽目录 查询任务的高级配置 任务配置高级配置 查询分支任务列表 父主题： API
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过
基本概念 表1 代码检查服务基本概念 词汇 定义 重复率 重复行数是指涉及至少一次重复的代码行数；重复块是指包含重复行的代码块（最小重复块定义：Java语言连续10行重复，其它语言10行中连续100个字符重复算一个重复块）；重复率=重复行/代码总行数（不包含空行与注释）。 规则
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题： API
量，帮助产品成功。 您可以使用本文档提供API对代码检查进行相关操作，如创建、删除、查询任务等。支持的全部操作请参见API概览。 在调用代码检查API之前，请确保已经充分了解代码检查基本概念。详细信息请参见产品介绍。 终端节点 终端节点即调用API的请求地址，不同服务不同区域的终
应用示例 示例1：查询任务列表 示例2：查询缺陷概要
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
请求消息头之外的内容。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token获取请求认证接口，您可以从接口的请求部分看到所需的请求参数及
完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求消息头，响应同样也有消息头，如“Content-type”。 对于管理员创建IAM用户接口，返回如图1所示的消息头。 图1 管理员创建IAM用户响应消息头
也可以通过其他接口查询概要等信息，更多使用方法参考API接口说明文档手册。 查询缺陷详情的响应结果。 相关参考 本示例中所有接口均可在华为云OpenAPI调试平台进行对应调试。 新建代码检查任务的API接口说明可参考新建检查任务。 执行代码检查任务的API接口说明可参考执行检查任务。
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题： API
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
您即将访问非华为云网站，请注意账号财产安全
