检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
代码检查服务可检查不同代码仓的代码质量,在创建代码检查任务前,需满足以下条件: 已新建CodeArts项目。 如果使用的是代码托管服务(CodeArts Repo)的代码仓库,则可以参考代码托管服务的“用户指南 > 新建Repo代码仓库”,完成新建代码仓库。 如果使用的是第三方代码仓库,需已创建可用的代码仓库。
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下: 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下: 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置。 增加任务配置高级配置。
配置代码检查任务 配置代码检查任务规则集 配置代码检查任务质量门禁 配置代码检查任务定时执行 配置代码检查任务消息通知 配置代码检查任务检查模式 查看徽标状态 配置代码检查任务集成服务 配置代码检查任务自定义环境 配置代码检查任务高级选项
续费管理”,进入“续费管理”页面。 自定义查询条件。 可在“手动续费项”、“自动续费项”、“到期转按需项”、“到期不续费项”页签查询全部待续费项,对套餐进行手动续费的操作,具体操作请参见如何恢复为手动续费。 在列表中找到需要续费的订单,单击操作列的“续费”。 选择续费时长,判断是否勾选
调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如
1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值
n认证要高。 关于认证鉴权的详细介绍及获取方式,请参见认证鉴权。 访问控制 代码检查对用户操作进行访问控制的方式如下: 角色权限控制:对代码检查任务、规则集的增删改查,规则查看,问题单的创建和导入导出等都均需获得对应的角色及权限。 细粒度权限控制:查询租户项目、设置项目创建者、管
需求选择。了解更多关于续费的信息,请参见续费概述。 费用账单 您可以在“费用中心 > 账单管理”查看与代码检查服务相关的流水和明细账单,以便了解您的消费情况。如需了解具体操作步骤,请参见费用账单。 欠费 在使用代码检查服务时,当账户的可用额度小于待结算的账单,即被判定为账户欠费。
准确定位到问题所在代码行,用户可以在线查看并分析代码问题。 延迟上线 在工具版本升级后,由于代码检查服务检查引擎的能力提升,可能会出现新的缺陷。但新检查出来的缺陷,不会计算到正式缺陷中,开发者拥有60天的缓冲周期对代码进行修改,周期内没有修改或者屏蔽的缺陷,在周期结束后后会计算到正式缺陷中。
1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数 参数 是否必选 参数类型
调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过A
task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
任务设置 API 代码检查 CodeArts Check(原CodeCheck)是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量,助力企业成功。 支持区域: 华北-北京一,华北-北京
} else { fmt.Println(err) } } 更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。 状态码 状态码 描述 200 Request succeeded! 400 Bad
Repo代码仓库中的代码质量 在代码开发过程中,编程人员能力和代码风格不一致,会影响代码的可阅读性和可维护性,例如代码注释要求。或者在某个平台/行业的代码编写要求比较特殊等一列问题,可通过使用代码检查服务检查代码质量。 本示例为您演示检查CodeArts Repo代码仓库中的代码质量,帮助您快速建立对代码检查服务的整体印象。
调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/ruleset 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过