检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
rkDown格式。字符数限制为0~10000。 是 正确示例 该规则对应的正确代码示例。代码内容支持使用MarkDown格式呈现。字符数限制为0~10000。 否 错误示例 不满足该规则的错误代码示例。代码内容支持使用MarkDown格式呈现。字符数限制为0~10000。 否 修复建议
2021-09-29 第十一次正式发布。本次变更说明如下: 修改错误码。 2021-05-08 第十次正式发布。本次变更说明如下: 删除约束与限制。 2021-03-26 第九次正式发布。本次变更说明如下: 终端节点中增加“华东-上海二”节点。 2021-02-05 第八次正式发布。本次变更说明如下:
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新
支持主流开发语言,内置9000+检查规则,便于用户开箱即用 代码检查服务支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTML/PHP/LUA/RUST/Shell/KOTLIN/SCALA/ArkTS/SQL等10+常见开发语言,满足嵌入式、WEB应用、移动应用等多种开发场景所需。
示例1:查询任务列表 场景描述 本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 约束限制 无。 涉及接口 涉及的接口如下: 查询任务列表:根据DEVCLOUD_PROJECT_UUID查询任务列表。 操作步骤 查询任务列表。 接口相关信息 URI格式:GET
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
配置代码检查任务检查模式 您可以根据实际需求设置检查模式和检查目录,提高检查效率。 约束与限制 C#语言和secbrella引擎均不支持MR合入。 设置MR检查模式 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。 进入“代码检查详情”页面,选择“设置
规则集则是一组用于做代码检查的规则组成的集合。一般根据不同的检查目标和需求,规则集也有相应的分类,比如对安全类、安卓应用、编程风格,使用这些类别进行检查的时候,规则集内的规则也会有所不同。 用户可根据实际需要更换代码检查任务使用的规则集,新启用的规则集将在下一次执行检查时生效。 代码检查服务支持
CodeArts Check套餐 规格 可选择“基础版”或“专业版”,差异如下。 基础版 支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTML/PHP/LUA/RUST/Shell/KOTLIN/SCALA/ArkTS/SQL10+种语言。
inc/.inl/.mm/.h/.hh/.hpp/.hxx/.h++ TYPESCRIPT .ts/.tsx RUST .rs ARKTS .ets C# .cs GO .go JAVASCRIPT .js/.jsx LUA .lua PYTHON .py 表4 Cmetrics工具支持检查C/C++的危险函数列表
如果使用的是代码托管服务(CodeArts Repo)的代码仓库,则可以参考代码托管服务的“用户指南 > 新建Repo代码仓库”,完成新建代码仓库。 如果使用的是第三方代码仓库,需已创建可用的代码仓库。 约束与限制 若删除的代码检查任务其代码仓为多分支代码仓,分支数量小于200时可删除成功,大于等于200会删除失败。
基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
修改任务规则集 查询任务检查失败日志 获取任务的目录树 任务配置屏蔽目录 查询任务的高级配置 任务配置高级配置 查询分支任务列表 父主题: API
TypeScript任务检查失败,日志显示404 问题现象 TypeScript任务检查失败,日志显示404。 处理方法 请检查上传的项目文件中是否包含“package-lock.json”文件。 如果包含,则删除“package-lock.json”文件,重新Push代码进行检查。
API 任务管理 缺陷管理 规则管理
如何调用API 构造请求 认证鉴权 返回结果
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
配置问题责任人精准匹配 您可根据实际需求,选择是否开启问题责任人精准匹配,将问题分配给不同的成员处理。 在“问题责任人精准匹配”区域,开启开关更新问题责任人匹配策略。 任务检查完成后,您可在“代码问题”页签下通过选择“负责人”过滤问题。 父主题: 配置代码检查任务