检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 设置媒体类型和编码格式
是否必选 参数类型 描述 current_path 否 String 目录或文件的路径 offset 否 Integer 分页索引,偏移量 limit 否 Integer 每页显示的数量,每页最多显示1000条 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID ruleset_id 是 String 规则集ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
分页索引,偏移量 limit 否 Integer 每页显示的数量,每页最多显示100条 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用I
参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID ruleset_id 是 String 规则集ID language 是 String 规则集语言 请求参数 表2 请求Header参数 参数
代码检查默认支持Java、C++、PHP、C#、JS、TypeScript、HTML、CSS、Go和Python语言的规则集,且每种语言类型对应多种不同级别的规则集。 代码检查除了默认规则集类型外,还可以根据实际需要自定义代码检查规则集。新规则集定义完成后,将代码检查任务的规则集修改为新规则集即可。 支持区域:
可在“手动续费项”、“自动续费项”、“到期转按需项”、“到期不续费项”页签查询全部待续费项,对套餐进行手动续费的操作,具体操作请参见如何恢复为手动续费。 在列表中找到需要续费的订单,单击操作列的“续费”。 选择续费时长,判断是否勾选“统一到期日”,将套餐到期时间统一到各个月的某一天(详细介绍请参见统一包
如何调用API 构造请求 认证鉴权 返回结果
代码检查通过多种数据保护手段和特性,保障数据安全可靠。 数据保护手段 简要说明 详细介绍 传输加密(HTTPS) 为保证数据传输的安全性,代码检查使用HTTPS传输数据。 构造请求 个人数据保护 通过控制个人数据访问权限以及记录操作日志等方法防止个人数据泄露,保证您的个人数据安全。 权限控制 隐私数据保护 涉及到用户
参见API概览。 在调用代码检查API之前,请确保已经充分了解代码检查基本概念。详细信息请参见产品介绍。 终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,服务的终端节点信息可参考地区和终端节点。 代码检查的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。
第六次正式发布。本次变更说明如下: 修改构造请求。 修改认证鉴权。 2020-08-06 第五次正式发布。本次变更说明如下: 增加应用示例。 示例1:查询任务列表。 示例2:查询缺陷概要。 2020-07-30 第四次正式发布。本次变更说明如下: 修改“请求示例”中URL地址信息。 修改终端节点。
杂度、代码重复率等。 操作步骤 接口相关信息 URI格式:GET /v2/tasks/{task_id}/defects-summary 请求示例 GET https://{endpoint}/v2/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/defects-summary
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
计费项 资源扩展计费说明 代码检查支持资源并发扩展,计费项为代码检查并发数。 表1 并发数计费 计费项 计费项说明 适用资源扩展类型 计费公式 代码检查并发数 某一Region内,租户中所有代码检查任务的并发执行数量总和。 代码检查并发扩展 单价*并发数*购买时长
查看指定订单账单 登录管理控制台。 在页面上方选择“费用 > 费用账单”,进入“账单概览”页面。 选择“流水和明细账单”,选择账期,设置筛选条件(产品类型“代码检查 CodeArts Check”、计费模式“包年/包月”),搜索对应账单。
帮助”单击前往代码仓对代码进行修改。 单击“创建问题单”,提交问题单给指定的责任人。该功能仅Scrum类型项目支持。 单击“查看问题单”,查看问题单详情。该功能仅Scrum类型项目支持。 单击“生成报告”,可将代码问题生成PDF格式的文件报告。 单击“全量操作 > 全量修改问题状
告警帮助提供告警详细描述、严重级别、告警类型、正确示例、错误示例及修复建议,您可以根据”严重程度/文件分类/规则分类”筛选查看告警。 按文件分类查看:打开CodeArts Check窗口,选择“Defects”页签,在检查结果区域左侧工具栏,单击(分类),选择“按文件分类进行查看”。 按严重级别后告警类型查看:打开CodeArts
Check的相关操作事件,方便您日后的查询、审计和回溯。 支持审计日志的操作 表1 云审计服务支持CodeArts Check服务操作 操作名称 资源类型 事件名称 创建代码检查任务 task create 修改代码检查任务 task modify 删除代码检查任务 task delete 执行代码检查任务