检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
请参见如何调用API。 URI POST /v2/ruleset 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token 是 String 用户Token 通过调用IAM服务获取用户Toke
/v3/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID 表2 Query参数 参数 是否必选 参数类型 描述 category 否 String 规则集类别 '
/v2/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID 表2 Query参数 参数 是否必选 参数类型 描述 category 否 String 规则集类别 0
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer
根据需要开启或关闭事件类型的通知状态。 开启服务动态通知,即通知当前任务所属项目的特定成员,可在消息中心查看消息。 开启邮件通知,即通知当前任务所属项目的特定成员,可在邮件中查看消息。 配置代码检查服务钉钉通知 进入钉钉群,找到“群设置 > 智能群助手”,然后添加机器人(选择自定义类型)。 填
参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
String 设置媒体类型和编码格式 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 info Array of TreeNode objects 任务的目录树信息 total Integer 数目 表5 TreeNode 参数 参数类型 描述 file_name
1”,无需手动填写。 代码源 选择“通用Git”。 任务名称 代码检查任务名称,可自定义。例如:CheckTask01。 Endpoint实例 选择新建通用Git服务扩展点中创建的服务扩展点“Endpoint01”。 仓库 保持默认即可。 分支 保持默认“master”即可。 检查语言
/v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页索引,偏移量
选择需要检查的代码来源。选择“GitCode”。 任务名称 代码检查任务名称,可自定义。例如:GitCodeCheckTask。。 Endpoint实例 选择新建GitCode服务扩展点中创建的服务扩展点“GitCode”。 仓库 选择需要检查的代码仓库,保持默认即可。 分支 选择需要检查的仓库分支,保持默认即可。
参数 参数类型 描述 exec_id String 执行id 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 设置媒体类型和编码格式 表3 请求Body参数 参数
参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
计费项 资源扩展计费说明 代码检查支持资源并发扩展,计费项为代码检查并发数。 表1 并发数计费 计费项 计费项说明 适用资源扩展类型 计费公式 代码检查并发数 某一Region内,租户中所有代码检查任务的并发执行数量总和。 代码检查并发扩展 单价*并发数*购买时长
查看指定订单账单 登录管理控制台。 在页面上方选择“费用 > 费用账单”,进入“账单概览”页面。 选择“流水和明细账单”,选择账期,设置筛选条件(产品类型“代码检查 CodeArts Check”、计费模式“包年/包月”),搜索对应账单。
路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID ruleset_id 是 String 规则集ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
Check的相关操作事件,方便您日后的查询、审计和回溯。 支持审计日志的操作 表1 云审计服务支持CodeArts Check服务操作 操作名称 资源类型 事件名称 创建代码检查任务 task create 修改代码检查任务 task modify 删除代码检查任务 task delete 执行代码检查任务