检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数
每页显示的数量,每页最多显示1000条 start_time 否 String 过滤开始时间,根据任务检查开始时间过滤 end_time 否 String 过滤结束时间,根据任务检查结束时间过滤 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
task_id对应任务下已创建的分支任务信息 表5 BranchTaskInfo 参数 参数类型 描述 taskId String 任务ID branchName String 任务名 isDefault String 是否为默认分支 status String 最近一次代码检查成功与否 状态码: 400
状态码: 200 表3 响应Body参数 参数 参数类型 描述 info Array of RuleListItem objects 规则信息 total Integer 总数 表4 RuleListItem 参数 参数类型 描述 rule_set String 规则集规范分类 rule_id
/v2/tasks/{task_id}/ruleset 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数
状态码: 200 表4 响应Body参数 参数 参数类型 描述 info Array of RulesetItem objects 规则集列表信息 total Integer 总数 表5 RulesetItem 参数 参数类型 描述 template_id String 规则集id language
单击任务名称时提示权限不足 问题现象 在代码检查服务任务列表中,单击任务名称,提示权限不足。 原因分析 操作的用户项目权限不足,当账号的项目权限为“测试经理”、“测试人员(含跨租户)”、“浏览者(含跨租户)”时,没有访问查看代码检查任务的权限。 处理方法 联系项目管理员(项目创建者、项目经理)修改当前账号角色。
为了避免不必要的计费,若您不再使用代码检查服务,建议您关闭服务。关闭服务后,代码检查任务会被删除,无法再进行检查,服务将停止计费。 登录CodeArts控制台,在左侧导航中单击“代码检查”。 选择“开通记录”页签,单击操作列“关闭服务” 根据弹窗提示,单击“确认”,关闭服务。 页面提示“已成功取消代码检查服务”,开通记录中“状态”显示为“已关闭”。
示例1:查询任务列表 场景描述 本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 约束限制 无。 涉及接口 涉及的接口如下: 查询任务列表:根据DEVCLOUD_PROJECT_UUID查询任务列表。 操作步骤 查询任务列表。 接口相关信息 URI格式:GET
project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数
任务执行完成后没有数据 问题现象 任务执行检查完毕后没有数据。 原因分析 源代码仓语言没有获取到。 检查语言开关没有打开。 处理方法 进入任务“设置 > 规则集”页面。 单击“已包含语言”所在行重新获取代码仓语言。 打开需要检查语言的开关。 重新执行检查。 父主题: 技术类问题
String 代码仓分支,如果是MR模式,为源分支 created_at String 创建时间 last_check_time String 上一次检查时间 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
删除自定义规则集 功能介绍 删除自定义规则集,正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
创建自定义规则集 功能介绍 可根据需求灵活的组合规则。 调用方法 请参见如何调用API。 URI POST /v2/ruleset 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token
状态码: 200 表4 响应Body参数 参数 参数类型 描述 info Array of RuleItem objects 规则集的规则列表信息 total Integer 总数 表5 RuleItem 参数 参数类型 描述 rule_id String 规则id rule_language
401 Unauthorized { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } SDK代码示例 SDK代码示例如下。 Java Python Go 更多 1 2 3 4 5 6 7 8 9
查询规则集列表-V3 功能介绍 根据项目ID、语言等条件查询规则集列表,与V2接口相比,限制了分页参数大小,V2接口后续将下线。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id
project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 表2 Query参数
project_id 是 String 项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数