检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询任务规则集的检查参数v3 功能介绍 查询任务规则集的检查参数v3 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters 表1 路径参数 参数
获取规则列表接口 功能介绍 根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity
处理流程,帮助企业有效管控代码质量,助力企业成功。 使用流程 表1 使用流程说明 流程 说明 购买CodeArts Check 指导您如何开通代码检查服务。 配置CodeArts Check项目级角色权限 为您介绍如何配置CodeArts Check服务项目级权限以及访问代码检查服务首页的方式。
先缓存起来,避免频繁调用。 使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息
旧版代码检查计费方式如何收费? 本章节仅供老用户参考。 代码检查服务依赖需求管理服务,开通前请先开通需求管理服务。 服务的开通需要区分区域,因此开通前注意选择自己需要开通的区域。 服务开通后,需注意创建的资源也分区域。 例如,在“华北-北京四”中创建了“项目A”,在下次查看“项目A”时,
查看代码检查结果 前提条件 您已创建并执行代码检查任务。 查看代码检查详情 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,搜索目标任务。在任务列表页,可以查看检查任务的状态。 新问题:表示本次代码检查任务执行后新增的问题。 未解决:表示该代码检查任务未解决的问题。
在页面上方选择“费用 > 续费管理”,进入“续费管理”页面。 自定义查询条件。 可在“手动续费项”、“自动续费项”、“到期转按需项”、“到期不续费项”页签查询全部待续费项,对套餐进行手动续费的操作,具体操作请参见如何恢复为手动续费。 在列表中找到需要续费的订单,单击操作列的“续费”。 选择续费
update_issueOwner 修改问题评论 issueComment update_issueComment 查看审计日志 用户需要在云审计服务CTS的管理控制台查询CodeArts Check服务的事件列表。详情请参考查看审计事件。
约束与限制 配置当天时间间隔必须在5分钟以上。 配置执行计划 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。 进入“代码检查详情”页面,选择“设置 > 执行计划”。 开启“定时执行”开关,并设置自动执行时间。 图1 配置执行计划
请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。
执行GitCode代码检查任务 在代码检查页面任务列表中,单击“GitCodeCheckTask”代码检查任务所在行。 根据页面提示等待任务执行完成。 查看GitCode代码检查详情 在代码检查页面任务列表中,搜索新建GitCode代码检查任务创建的任务名称。 单击任务名称,查看代码检查详情,包括概览、代码问题、代码度量、检查日志等。
/v2/tasks/{task_id}/progress “task_id”中填入MR任务ID以查询任务执行状态,任务状态0表示检查中,1表示检查失败,2表示检查成功,3表示任务中止。 轮询任务执行状态的返回结果。 查询缺陷详情 查询缺陷详情请求示例。 ShowTaskDefects:GET /v2/ta
如何调用API 构造请求 认证鉴权 返回结果
environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"]
查看徽标状态 执行完代码检查任务后,您可通过徽标状态查看代码健康度,并标识在代码仓库中。 代码检查服务中设置各个告警级别的影响度如下: 致命:5 严重:3 一般:1 提示:0.1 健康度=SUM ∑(告警数量*告警级别影响度)/代码量,各个健康度对应的标识如下: A:健康度<=0
environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"]
environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"]
配置代码检查任务高级选项 配置新问题起始时间 在每个任务的基础上可以设置新问题起始时间。起始时间设置之后要重新扫描,问题的发现时间大于设置时间将被划分为新问题。如果没有设置起始时间,连续两次的检查结果对比,新增的就是新问题数。 基于项目入口访问CodeArts Check服务首页。
如果您想继续使用,需要在指定的时间内为代码检查服务续费。 代码检查服务在到期前续费成功,代码检查服务可正常使用,且代码检查任务的运行不受影响。代码检查服务到期后的状态说明,请参见到期后影响。 续费相关的功能 代码检查服务续费相关的功能如表1所示。 表1 续费相关的功能 功能 说明
作指导,帮助用户轻松检查代码。 表1 CodeArts Check最佳实践一览表 最佳实践 说明 使用预置规则检查GitCode代码仓中的代码质量 如果您的代码存放在GitCode代码仓中,可参考本实践的操作指导完成检查代码质量。本实践为您介绍如何使用系统预置规则检查GitCode代码仓中的Java语言代码质量。