检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
续费 续费概述 手动续费 自动续费
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志 获取任务的目录树 任务配置屏蔽目录 查询任务的高级配置 任务配置高级配置 查询分支任务列表
需求管理服务。 服务的开通需要区分区域,因此开通前注意选择自己需要开通的区域。 服务开通后,需注意创建的资源也分区域。 例如,在“华北-北京四”中创建了“项目A”,在下次查看“项目A”时,需先切换到“项目A”所在区域“华北-北京四”。 代码检查服务为免费使用。 开通服务前可以免费体验,即提供10万行代码免费额度。
可选,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参考AK/SK认证。 X-Sdk-Date:请求发送的时间,可选,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。AK/SK认证的详细说明请参考AK/SK认证。
统一包年/包月资源的到期日 统一到期日是指通过续费将包年/包月实例的到期日统一固定为一个月的某一天。 如果您购买的代码检查服务套餐、资源扩展的到期日不同,可以将到期日统一设置到固定一个日期,便于日常管理和续费。 图1展示了用户将两个不同时间到期的资源,同时续费一个月,并设置“统一到期日”后的效果对比。
详细介绍 传输加密(HTTPS) 为保证数据传输的安全性,代码检查使用HTTPS传输数据。 构造请求 个人数据保护 通过控制个人数据访问权限以及记录操作日志等方法防止个人数据泄露,保证您的个人数据安全。 权限控制 隐私数据保护 涉及到用户的数据库账号信息需要存储时,提供敏感数据加密存储。
该任务正在运行,造成流水线执行失败。 处理方法 访问流水线服务首页。 在流水线任务列表页单击失败的流水线任务名称。 单击流水线任务任一执行历史。 单击代码检查插件。 单击“详情”,从流水线任务中访问当前使用的代码检查任务。 确认当前任务是否正在运行,如果在执行请等待执行完成后,再开始运行流水线。
String 该任务对应临时仓库有权限的用户token,参数计划下线,不建议使用 git_url 否 String 该任务对应的临时仓库地址,参数计划下线,不建议使用 git_branch 否 String 该任务对应的临时仓库分支,参数计划下线,不建议使用 响应参数 状态码: 200 表4
rule_languages 否 String 规则对应的语言 rule_severity 否 String 缺陷等级,0致命;1严重;2一般;3提示。默认全部查询 offset 否 Integer 分页索引,偏移量 limit 否 Integer 每页显示的数量 请求参数 表2 请求Header参数
template_create_time String 创建时间 is_used String 使用状态1使用中,0空闲中 rule_ids String 规则集包含的规则id,每条规则都有1个唯一的规则id is_default String 是否是该语言默认规则集,0不是,1是 is
template_create_time String 创建时间 is_used String 使用状态1使用中,0空闲中 rule_ids String 规则集包含的规则id,每条规则都有1个唯一的规则id is_default String 是否是该语言默认规则集,0不是,1是 is
购买代码检查并发扩展前,须完成代码检查服务基础版及以上规格套餐的购买。 代码检查并发扩展的购买上限为100并发。 计费公式 单价*并发数*购买时长。 计费周期 根据购买时长确定(以GMT+08:00时间为准)。一个计费周期的起点是您开通或续费代码检查并发扩展的时间(精确到秒),终点则是到期日的23:59:59。 例如,您在2023/03/08
务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type