检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API类问题 使用公共API时提示没有权限 使用公用API时提示项目不存在
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
如何调用API 构造请求 认证鉴权 返回结果
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
附录 状态码 错误码 获取项目ID 获取账号ID
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
产品特性 自研代码检查引擎 支持五大业界主流标准和华为编程规范 支持主流开发语言 日均百亿级扫描能力 一站式问题闭环修复 “代码编写、代码合并、版本发布”三层缺陷防护 代码检查安全增强
在下次查看“项目A”时,需先切换到“项目A”所在区域“华北-北京四”。 代码检查服务为免费使用。 开通服务前可以免费体验,即提供10万行代码免费额度。 开通服务后可以免费使用。 当使用量超出免费额度(10万行)时,系统会提示开通按需使用或购买套餐。请根据实际需要开通代码检查服务。
代码检查服务提供检查结果统计,并对检查出的问题提供修改建议,可以根据修改建议优化项目代码。 在代码检查任务中,选择“概览”页签,即可查看任务执行结果统计。 单击“代码问题”页签,即可看到问题列表。 单击问题框中的“问题帮助”,可以查看系统对此问题的修改建议。可以根据需要在代码仓库中找到对应文件及代码位置,参考修改建议优化代码。
创建代码检查任务 执行代码检查任务 查看代码检查详情 计费说明 代码检查是软件开发生产线CodeArts中的一个服务,可单独购买使用,也可以开通CodeArts基础版或购买CodeArts专业版即可使用代码检查服务。 支持区域: 华北-北京一,华北-北京四,华东-上海一,华东-
当调用出错时,如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题。 错误响应Body体格式说明 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。
查看代码检查详情 02 入门 从0到1,快速学习代码检查服务。 快速入门 代码检查基本流程 04 API 通过代码检查开放的API和调用示例,您可以对任务、缺陷、规则等进行管理。 API文档 使用前必读 API概览 如何调用API 附录 常见问题 了解更多常见问题、案例和解决方案 热门案例
参考实名认证完成个人或企业账号实名认证。 购买CodeArts Check须知 在CodeArts支持的区域内,各区域独立开通/购买、独立计费。 您可以购买CodeArts Check,或者开通/购买软件开发生产线服务组合套餐,体验一站式、全流程、安全可信的软件开发生产线。 若已经购买了C
使用自定义规则检查CodeArts Repo代码仓中的代码质量 应用场景 随着现在项目的代码量越来越大,以及现有开发框架的增加,静态分析所需要覆盖的场景也日益增多,存在的问题如下: 传统静态分析引擎靠工具提供通用规则来对常见安全,风格和质量场景下的编码问题进行扫描分析,难以实时覆盖不同用户特定场景下的代码问题。
获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中“projects”下的“id”即为项目ID。 { "projects":
是否必选 参数类型 描述 check_id 是 Integer 检查工具ID,参数已废弃 ruleset_id 是 String 规则集ID,可以通过查询任务的已选规则集列表接口获取 language 是 String 规则集语言 status 是 String off:关闭,on:开启,参数已废弃
enable_fossbot 否 Boolean 是否打开fossbot检查,默认不开 resource_pool_id 否 String 资源池id,可以从资源池管理页面获取 表4 RuleSetV2 参数 是否必选 参数类型 描述 ruleset_id 否 String 规则集id,需要从web界面获取