检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建自定义规则集 功能介绍 可根据需求灵活的组合规则。 调用方法 请参见如何调用API。 URI POST /v2/ruleset 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token
由用户创建“.kirin”文件编写dsl规则,然后通过运行本地插件在“OutputReport”目录下生成“SecH_自定义规则名.json”的源码文件,上传json文件即可。使用插件生成规则文件可参考插件使用指南。 是 严重级别 该规则检查出的代码问题的严重级别,分为致命、严重、一般和提示。
“+访问令牌”,填写令牌名称以及到期时间。 单击“新建访问令牌”,生成“你的个人访问令牌”,即Token。 单击,即可复制生成的Token。 说明: Token生成后,请及时保存,下次刷新页面将无法读取,需要重新生成新Token。 注意填写有效的Token描述信息,避免误删除导致构建失败。
warning_suppression_total 抑制告警数。 统计被扫描文件的告警抑制语句出现的数量。注释中的字符串符合特定正则表达式,则会被认为是告警抑制语句。不同语言对应的正则表达式请参考表5。 该参数需启用Cmetrics规则后生效。 warning_suppression_kloc
language 是 String 规则集语言 rule_set_id 是 String 规则集ID,通过调用ListTaskRuleset接口,根据响应参数中的template_id获得 if_use 是 String 任务语言和规则集的关系是否启用,1是启用,0是未启用 status
选择需要检查的代码语言,选择“Java”。 单击“新建任务”,完成检查任务的创建。 执行通用Git代码检查任务 在代码检查页面任务列表中,单击代码检查任务所在行执行任务。 根据页面提示等待任务执行完成。 查看代码检查结果 在代码检查页面任务列表中,搜索创建通用Git代码检查任务创建的任务名称“CheckTask01”。
资源池配置参数说明 参数名称 参数说明 资源池名称 资源池的名称,根据需要自定义。例如:custom_pool。 资源池类型 选择LINUX_DOCKER。执行任务时将拉起一个Linux docker容器,任务在容器中运行。 资源池描述 根据需要输入资源池描述。可不填写。 资源池可以被租户下所有子用户使用
改问题状态、转移责任人和根据“问题帮助”单击前往代码仓对代码进行修改。 单击“创建问题单”,提交问题单给指定的责任人。该功能仅Scrum类型项目支持。 单击“查看问题单”,查看问题单详情。该功能仅Scrum类型项目支持。 单击“生成报告”,可将代码问题生成PDF格式的文件报告。 单击“全量操作
未受控的格式化字符串 不支持 支持 攻击者可利用格式化字符串漏洞实现控制程序行为和信息泄露。 不支持 支持 跨站脚本攻击(XSS) 支持 支持 攻击者利用在网站、电子邮件中的链接插入恶意代码,盗取用户信息。 不支持 支持 LDAP注入 支持 支持 利用用户输入的参数生成非法LDAP查询,盗取用户信息。
Repo代码源检查任务参数说明 参数 说明 所属项目 任务所属项目。 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。 以服务入口访问时需根据实际情况选择新建项目中创建的项目。 代码源 选择Repo,检查代码托管服务中的代码质量。 任务名称 代码检查任务名称,可自定义。 支持中英
--cli-region="cn-north-4" --task_id="9fd08c41a9824a69afdb9aca17590e29"即为生成的调用命令。 图2 生成API调用命令 参考4,依次获得查询任务执行状态(ShowProgressDetail)、查询缺陷概要(ShowTaskDetail)API的调用命令。
资源池配置参数说明 参数名称 参数说明 资源池名称 资源池的名称,根据需要自定义。例如:custom_pool。 资源池类型 选择LINUX_DOCKER。执行任务时将拉起一个Linux docker容器,任务在容器中运行。 资源池描述 根据需要输入资源池描述。可不填写。 资源池可以被租户下所有子用户使用
在弹出的窗口中选择需要检查的文件或者目录,单击“Scan”。 扫描完成后,单击界面左下角的告警显示具体的代码片段。同时,会在同目录的OutputReport文件中生成“.json”格式的规则文件。 创建自定义规则 在页面导航栏中选择“代码 > 代码检查”。 单击“规则”页签。 单击“新建规则”,参考表2配置参数。
配置代码检查任务集成服务 当代码托管中有分支合并时,在代码检查服务中可以设置自动检查代码检查任务,并生成一个子任务,即代码仓库中有分支合并,就会重新生成一个代码检查子任务。 配置MR检查状态 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。
String 错误码 error_msg String 错误描述 请求示例 执行检查任务:执行任务对应代码仓URL根据实际显示,代码仓分支为master,用户名根据实际显示 POST https://{endpoint}/v2/tasks/{taskid}/run 响应示例 状态码:
String 错误码 error_msg String 错误描述 请求示例 新建检查任务:检查任务的检查类型为source,对应代码仓URL根据实际情况显示,代码仓分支为master,语言类型为cpp POST https://{endpoint}/v2/{project_id}/task
描述 error_code String 错误码 error_msg String 错误描述 请求示例 修改任务缺陷的状态:缺陷的状态ID根据实际显示,缺陷的状态修改为1 PUT https://{endpoint}/v2/tasks/{taskid}/defect-status
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个Code
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个C