检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID 表2 Query参数 参数 是否必选 参数类型 描述 category 否 String 规则集类别 '0只查询系统规则集
约束与限制 购买须知 不同区域购买的资源不能跨区使用,需慎重选择。 如果已经购买了CodeArts套餐,则无需再单独购买CodeArts Check套餐。 命名限制 限制项 说明 检查任务名称 支持中英文,数字,点,下划线“_”和连接符“-”。 字符长度范围为1~128。 规则集名称
页面右上角提示开通进行中,成功开通后系统自动返回控制台。 在“开通记录”页签可查看服务开通记录。 关闭服务 为了避免不必要的计费,若您不再使用代码检查服务,建议您关闭服务。关闭服务后,代码检查任务会被删除,无法再进行检查,服务将停止计费。
Cmetrics工具规格说明 工具介绍 Cmetrics是华为公司自研代码度量工具,通过扫描源码对各项指标进行度量。度量指标包括代码量、函数圈复杂度、文件代码行、函数代码行、文件重复、代码重复、危险函数、冗余代码等多项指标。当前工具版本为2.1.5。 参数说明 表1 参数说明 参数
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 父主题: 附录
支持主流开发语言 支持主流开发语言,内置9000+检查规则,便于用户开箱即用 代码检查服务支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTML/PHP/LUA/RUST/Shell/KOTLIN/SCALA/ArkTS/SQL
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
图解CodeArts Check
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,
计费模式概述 代码检查服务采用包年/包月计费模式,提供资源扩展。 包年/包月是一种先付费再使用的计费模式,适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式,您可以预先购买代码检查服务。本文将介绍包年/包月代码检查服务的计费规则。 父主题: 计费模式
执行代码检查任务时报错:CC.00030117.400 规则集无版本级规则,请检查规则集配置 问题现象 执行代码检查任务时,错误信息提示:CC.00030117.400,规则集无版本级规则,请检查规则集配置。 原因分析 用户配置的规则集没有版本级规则,但是执行了版本级扫描,需要重新配置规则集
查询异步任务 功能介绍 根据生成PDF报告接口返回的asyncJobId,查询生成PDF的进度 调用方法 请参见如何调用API。 URI GET /v1/tasks/{task_id}/async-job/{async_job_id} 表1 路径参数 参数 是否必选 参数类型 描述
下载PDF报告 功能介绍 根据查询异步任务接口返回的jobFile路径,下载对应的PDF报告,不可重复下载 调用方法 请参见如何调用API。 URI GET /v1/tasks/{task_id}/pdf-file 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是
生成PDF报告 功能介绍 开始一个生成PDF的异步任务 调用方法 请参见如何调用API。 URI PUT /v1/tasks/{task_id}/pdf-async-job 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值
查询缺陷概要 功能介绍 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_id
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值
日均百亿级扫描能力 日均百亿级扫描能力,支持大型企业超大规模代码检查 代码检查具备强大的高并发处理能力,在华为内部,日常15万+软件开发人员高频代码提交增量检查,每日凌晨所有代码仓定时检查,服务日均扫描百亿行级代码。 服务通过AZ容灾、跨region级容灾多活、支持过载保护、服务依赖和隔离等一系列高可用特性
灵活匹配用户场景 支持自定义规则,灵活匹配用户场景 在软件开发实践中,代码质量管控面临着多样化的现实挑战:例如,不同团队的编码规范存在差异(如特定命名规则、注释格式),复杂业务场景需要定制化逻辑校验,新兴技术框架的最佳实践需要强制落地,通用代码检查工具的内置规则往往聚焦于语法合规、
购买并授权使用CodeArts Check 购买CodeArts Check