检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
创建自定义规则集 功能介绍 可根据需求灵活的组合规则。 调用方法 请参见如何调用API。 URI POST /v2/ruleset 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是
算。 查看指定订单账单 登录管理控制台。 在页面上方选择“费用 > 费用账单”,进入“账单概览”页面。 选择“流水和明细账单”,选择账期,设置筛选条件(产品类型“代码检查 CodeArts Check”、计费模式“包年/包月”),搜索对应账单。
欠费后需要及时充值,详细操作请参见账户充值。 若账户中的按需资源不再被使用,您可以将其删除,以免继续扣费。 您可以在“费用中心 > 总览”页面设置“可用额度预警”功能,当可用额度、通用代金券和现金券的总额度低于预警阈值时,系统自动发送短信和邮件提醒。 当产生欠费后,请您及时充值使可用额度大于0。
角色权限控制:对代码检查任务、规则集的增删改查,规则查看,问题单的创建和导入导出等都均需获得对应的角色及权限。 细粒度权限控制:查询租户项目、设置项目创建者、管理租户项目成员列表等操作需要获得IAM细粒度授权。 父主题: 安全
根据任务ID查询任务执行状态。任务状态:0表示检查中,1表示检查失败,2表示检查成功,3表示任务中止。只有正在检查中才有进度的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/progress 表1 路径参数 参数 是否必选 参数类型
查询缺陷详情的统计 功能介绍 根据检查任务ID查询缺陷详情的统计 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-statistic 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务I
查询分支任务列表 功能介绍 查询分支任务列表 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/branches 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每
若确认无误,继续根据页面提示完成支付。 变更并发数 代码检查并发扩展支持变更并发数。 登录代码检查控制台。 找到待变更的资源扩展记录,单击“变更”。 根据需要设置并发数,勾选同意声明,单击“下一步”。 确认订单内容:若需要修改,单击“上一步”。 若确认无误,继续根据页面提示完成支付。 购买资源扩展
Repo服务的代码质量,同时也可使用服务扩展点连接第三方代码仓库检查代码质量。 在项目下的CodeArts Check服务页面的导航栏选择“设置 > 通用设置 > 服务扩展点管理”。 单击“新建服务扩展点”,在下拉列表中选择“通用Git”。 在弹框中配置以下信息,单击“确定”。 表2 新建通用Git服务扩展点
历史扫描结果查询 功能介绍 提供每次扫描的问题数量统计 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/checkrecord 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
统计工程中所有代码文件的物理行总数,包含空行和注释行。 methods_total 函数总数。 统计工程中所有代码文件的方法总个数。其中Java抽象方法的方法声明后不带函数体,不会被识别成函数。 cyclomatic_complexity_total 圈复杂度总数。 统计所有函数圈复杂度数的总和。
Repo服务的代码质量,同时也可使用服务扩展点连接第三方代码仓库检查代码质量。 在项目下的CodeArts Check服务页面的导航栏选择“设置 > 通用设置 > 服务扩展点管理”。 单击“新建服务扩展点”,在下拉列表中选择“通用Git”。 在弹框中配置以下信息,单击“确定”。 表2 新建通用Git服务扩展点
获取规则列表接口 功能介绍 根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity
代码检查”,页面中显示样例项目内置的4个任务。 在列表中找到任务“phoenix-codecheck-worker”。 单击任务名称进入详情页,选择“设置”页签。 单击导航“规则集”,规则集中默认包含的语言是“JAVA”。 增加Python语言检查规则集。 单击“已包含语言”之后的图标,重新
查询规则集列表-V3 功能介绍 根据项目ID、语言等条件查询规则集列表,与V2接口相比,限制了分页参数大小,V2接口后续将下线。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询规则集列表 功能介绍 根据项目ID、语言等条件查询规则集列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个Code
代码检查安全增强 CodeArts Check提供代码安全检查增强包的能力,其安全检查能力作为深度价值特性,能深度识别代码中安全风险和漏洞,提供了套餐包内规则不覆盖的安全类场景,比如数值错误、加密问题、数据验证问题等。针对业界的安全漏洞检测项提供了更深入的分析能力,如跨函数、跨文件、污点分析、语义分析等。
查看规则集的规则列表 功能介绍 根据项目ID、规则集ID等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/ruleset/{ruleset_id}/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询缺陷概要 功能介绍 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_id