检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 返回结果
HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更
配置完成后,当任务运行结果满足事件类型时,代码检查服务会发送消息到指定的钉钉群。 配置代码检查服务企业微信通知 在企业微信群群里添加群机器人。(以手机客户端为例,详细指导请参考如何设置群关系机器人。) 运行企业微信客户端,选中需要接受消息推送的群聊,单击右上角三个点按钮。 单击“群机器人”。
服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。返回该状态码,表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。
查询任务的高级配置 功能介绍 查询任务的高级配置 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID
项目中使用了私有依赖,但没有配置私有依赖扩展点。 处理方法1 在代码检查详情页,选择“设置 > 规则集 > 检查参数”。 在编译命令中使用“-s settings.xml”指定Maven编译使用的settings。 处理方法2 在项目详情页,选择“设置 > 通用设置 > 服务扩展点管理”页面,增加“nexus repository”扩展点。
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中“{Endpoint}”为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
配置项为目录且不支持文件,默认检查代码仓中所有代码。 配置的目录层级中不能包含“.”开头的目录。 如果检查目录输入框路径为空,则默认全部检查。如果有指定检查目录,则只检查检查目录中的文件,如果指定的检查目录中有勾选设置忽略文件,则被忽略的文件不参与检查。 检查目录只生效于不需要编译的文件。例如,A文件编译后产生了B文件,则不会输出B文件上的告警。
获取规则列表接口 功能介绍 根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity
弹出配置窗口。 单击配置窗口中“规则”左侧的图标可以查看规则详细信息。 根据实际需要确定勾选是否自动触发代码检查,然后输入检查的屏蔽目录和指定的扫描目录。 可以查看当前被激活/应用到的规则(包括状态、危险级别、编程语言、引擎标签、规则类型)或者根据规则集筛选规则(所有规则集/推荐规则集)。
旧版代码检查计费方式如何收费? 本章节仅供老用户参考。 代码检查服务依赖需求管理服务,开通前请先开通需求管理服务。 服务的开通需要区分区域,因此开通前注意选择自己需要开通的区域。 服务开通后,需注意创建的资源也分区域。 例如,在“华北-北京四”中创建了“项目A”,在下次查看“项目
续费概述 续费简介 包年/包月服务到期后会影响代码检查服务正常运行。如果您想继续使用,需要在指定的时间内为代码检查服务续费。 代码检查服务在到期前续费成功,代码检查服务可正常使用,且代码检查任务的运行不受影响。代码检查服务到期后的状态说明,请参见到期后影响。 续费相关的功能 代码检查服务续费相关的功能如表1所示。
新建检查任务 功能介绍 新建检查任务但是不执行。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID
"error_code": "IAM.0011" } 其中,error_code表示错误码,error_msg表示错误描述信息。 父主题: 如何调用API
Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。 AK/SK认证 AK/SK签名
配置CodeArts Check项目级角色权限 新增的成员需赋予指定的角色,不同角色具备的默认权限不同。各角色具备的默认权限如表1。 表1 代码检查服务默认角色权限 资源权限/角色 项目管理员 项目经理 开发人员 测试经理 测试人员 参与者 浏览者 运维经理 产品经理 系统工程师
单击“查看上下文”,在问题详情页面中,可修改问题状态、转移责任人和根据“问题帮助”单击前往代码仓对代码进行修改。 单击“创建问题单”,提交问题单给指定的责任人。该功能仅Scrum类型项目支持。 单击“查看问题单”,查看问题单详情。该功能仅Scrum类型项目支持。 单击“生成报告”,可将代码问题生成PDF格式的文件报告。
查询cmetrics缺陷概要 功能介绍 根据检查任务ID查询cmetrics缺陷概要。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/metrics-summary 表1 路径参数 参数 是否必选 参数类型 描述
您可以在“费用中心 > 账单管理”查看资源的费用账单。 账单上报周期 购买代码检查服务套餐、资源扩展完成支付后,会实时上报一条账单到计费系统进行结算。 查看指定订单账单 登录管理控制台。 在页面上方选择“费用 > 费用账单”,进入“账单概览”页面。 选择“流水和明细账单”,选择账期,设置筛选条件(产品类型“代码检查