检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
示例1:查询任务列表 场景描述 本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 约束限制 无。 涉及接口 涉及的接口如下: 查询任务列表:根据DEVCLOUD_PROJECT_UUID查询任务列表。 操作步骤 查询任务列表。 接口相关信息 URI格式:GET
检查任务列表可查看对应仓库的检查任务。 以下示例为在代码托管服务中创建云端仓库不勾选“自动创建代码检查任务”时,Repo代码源代码检查任务的创建步骤。 基于项目入口访问CodeArts Check服务首页。 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表1配置参数。
角色权限控制:对代码检查任务、规则集的增删改查,规则查看,问题单的创建和导入导出等都均需获得对应的角色及权限。 细粒度权限控制:查询租户项目、设置项目创建者、管理租户项目成员列表等操作需要获得IAM细粒度授权。 父主题: 安全
、通用质量与网络安全风险等丰富的检查能力,提供全面的质量报告、便捷的问题闭环处理流程,帮助企业有效管控代码质量,助力企业成功。 使用流程 表1 使用流程说明 流程 说明 购买CodeArts Check 指导您如何开通代码检查服务。 配置CodeArts Check项目级角色权限
1表示检查失败,2表示检查成功,3表示任务中止。 轮询任务执行状态的返回结果。 查询缺陷详情 查询缺陷详情请求示例。 ShowTaskDefects:GET /v2/tasks/{task_id}/defects-detail “task_id”中填入MR任务ID以查询缺陷详情
String 高级配置对应的名称 value 是 String 高级配置对应的取值 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Body参数
查询规则集列表-V3 功能介绍 根据项目ID、语言等条件查询规则集列表,与V2接口相比,限制了分页参数大小,V2接口后续将下线。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id
String 主事件对应的代码片段 code_context String 代码上下文 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表9 响应Body参数
以满足不同规模用户的使用需求。套餐详情介绍请参见包年/包月套餐说明。 进入购买CodeArts Check套餐页面。 参考表1根据实际需要进行购买。 表1 套餐包配置 配置项 配置详情 计费模式 包年/包月。 区域 选择需要使用的区域。不同区域购买的资源不能跨区使用,需慎重选择。
查询任务的已选规则集列表v3 功能介绍 查询任务的已选规则集列表v3。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
String 规则集ID 表2 Query参数 参数 是否必选 参数类型 描述 language 是 String 规则集语言 offset 否 Integer 分页索引,偏移量,非必填 limit 否 Integer 每页显示的数量,非必填 请求参数 表3 请求Header参数 参数
量任务都有1个唯一的任务ID ruleset_id 是 String 规则集ID 表2 Query参数 参数 是否必选 参数类型 描述 language 是 String 规则集语言 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否
查询任务的已选规则集列表v2 功能介绍 查询任务的已选规则集列表v2。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
warning_suppression_total 抑制告警数。 统计被扫描文件的告警抑制语句出现的数量。注释中的字符串符合特定正则表达式,则会被认为是告警抑制语句。不同语言对应的正则表达式请参考表5。 该参数需启用Cmetrics规则后生效。 warning_suppression_kloc 抑制告警密度。
代码检查默认支持Java、C++、PHP、C#、JS、TypeScript、HTML、CSS、Go和Python语言的规则集,且每种语言类型对应多种不同级别的规则集。 代码检查除了默认规则集类型外,还可以根据实际需要自定义代码检查规则集。新规则集定义完成后,将代码检查任务的规则集修改为新规则集即可。
终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,服务的终端节点信息可参考地区和终端节点。 代码检查的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 代码检查的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京四 cn-north-4 codecheck-ext
第二十二次正式发布。本次变更说明如下: 修改查询任务的已选规则集列表v3。 修改查询任务规则集的检查参数v3。 修改错误码。 2022-09-22 第二十一次正式发布。本次变更说明如下: 修改错误码。 2022-09-06 第二十次正式发布。本次变更说明如下: 修改示例1:查询任务列表。 修改示例2:查询缺陷概要。
String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型 描述 check_id 是 Integer 检查工具ID,参数已废弃 ruleset_id 是 String 规则集ID,可以通过查询任务的已选规则集列表接口获取 language 是 String
力、并发扩展能力叠加。 不同版本套餐中,提供的功能特性及资源规格略有不同,详情请参见表1。 代码检查资源扩展包:在CodeArts或CodeArts Check套餐基础上,可以购买资源扩展包。 表1 代码检查套餐详情 代码检查套餐说明 适用场景 规格 特性 基础版 个人开发者和小微企业首选。
义规则。 如果需要支持扫描更多行数的代码或需要创建更多数量的规则,可咨询华为技术支持。 单击“规则”页签。 单击“新建规则”,参考表1配置参数。 表1 自定义规则参数配置说明 参数 说明 是否必填 规则名称 创建的规则名称,可自定义。 支持中英文,数字,点,下划线“_”和连接符“-”