检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 info Array of RuleListItem objects 规则信息 total Integer 总数 表4 RuleListItem 参数 参数类型 描述 rule_set String 规则集规范分类
参数 参数类型 描述 ratio String 进度百分比 info String 进度信息 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Body
否 String 规则集类别 '0只查询系统规则集,1只查询当前用户自定义规则集,2只查询其他用户自定义规则集,'0,1,2'或''查所有' offset 否 Integer 分页索引,偏移量 limit 否 Integer 每页显示的数量 请求参数 表3 请求Header参数
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 info Array of RuleItem objects 规则集的规则列表信息 total Integer 总数 表5 RuleItem 参数 参数类型 描述 rule_id String 规则id rule_language
否 String 规则集类别 0只查询系统规则集;1只查询当前用户自定义规则集;2只查询其他用户自定义规则集;0,1,2或空查所有 offset 否 Integer 分页索引,偏移量 limit 否 Integer 每页显示的数量 请求参数 表3 请求Header参数 参数 是否必选
响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 defects Array of DefectInfoV2 objects 缺陷详情信息 total Integer 总数 表5 DefectInfoV2 参数 参数类型 描述 defect_id String
URI GET /v2/{project_id}/tasks/{task_id}/metrics-summary 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id
1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
Content-Type 是 String 设置媒体类型和编码格式 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 info Array of TreeNode objects 任务的目录树信息 total Integer 数目 表5 TreeNode 参数
URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID 表2 Query参数 参数 是否必选 参数类型 描述 offset
参数 是否必选 参数类型 描述 file_path 是 String 目录或文件路径 checkbox_status 是 String 屏蔽状态,包括unchecked(不屏蔽)、all(全屏蔽)、half(半屏蔽) 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型
描述 exec_id String 执行id 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code
Content-Type 是 String 设置媒体类型和编码格式 表3 请求Body参数 参数 是否必选 参数类型 描述 defect_id 是 String 问题id唯一,可使用查询缺陷详情接口获取,更新多个时可使用字符','组合 defect_status 是 String
表1 并发数计费 计费项 计费项说明 适用资源扩展类型 计费公式 代码检查并发数 某一Region内,租户中所有代码检查任务的并发执行数量总和。 代码检查并发扩展 单价*并发数*购买时长
选择“流水和明细账单”,选择账期,设置筛选条件(产品类型“代码检查 CodeArts Check”、计费模式“包年/包月”),搜索对应账单。
代码检查除了默认规则集类型外,还可以根据实际需要自定义代码检查规则集。新规则集定义完成后,将代码检查任务的规则集修改为新规则集即可。
响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg
例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。