检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用公用API时提示项目不存在 问题现象 使用公用API提示项目不存在。 原因分析 taskId错误导致。 处理方法 使用正确的taskId。如果仍然未能解决,请联系技术支持工程师。 父主题: API类问题
基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,搜索目标任务。在任务列表页,可以查看检查任务的状态。 新问题:表示本次代码检查任务执行后新增的问题。 未解决:表示该代码检查任务未解决的问题。 已解决:表示该代码检查任务已解决的问题。 单击检查任务名称,进入代码检查详情概览页,可查看的信息如下:
查询规则集列表-V3 功能介绍 根据项目ID、语言等条件查询规则集列表,与V2接口相比,限制了分页参数大小,V2接口后续将下线。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个Code
查询规则集列表 功能介绍 根据项目ID、语言等条件查询规则集列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每个Code
查看规则集的规则列表 功能介绍 根据项目ID、规则集ID等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/ruleset/{ruleset_id}/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id
单击“确定”,进入到“规则集配置”页面。 勾选创建自定义规则中创建的规则,单击右上角“保存”。 创建代码检查任务 在代码检查任务列表页,单击“新建任务”,按照如下表格配置参数。 表3 代码检查任务参数说明 参数 说明 归属项目 创建代码检查任务所属项目中创建的项目名称“Scrum01”。默认填写,无需配置。
获取规则列表接口 功能介绍 根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity
et 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型
查询任务的已选规则集列表v2 功能介绍 查询任务的已选规则集列表v2。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下: 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下: 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置。
查询分支任务列表 功能介绍 查询分支任务列表 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/branches 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,每
查询任务的已选规则集列表v3 功能介绍 查询任务的已选规则集列表v3。 调用方法 请参见如何调用API。 URI GET /v3/{project_id}/tasks/{task_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
409 Conflict 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。返回该状态码,表明请求的资源已被永久删除。 411 Length Required 服务
在“源文件编码”区域,单击下拉框选择源文件编码。 完成后,提示修改成功。 配置问题责任人精准匹配 您可根据实际需求,选择是否开启问题责任人精准匹配,将问题分配给不同的成员处理。 在“问题责任人精准匹配”区域,开启开关更新问题责任人匹配策略。 任务检查完成后,您可在“代码问题”页签下通过选择“负责人”过滤问题。
Check配置”界面功能说明请参见图1和表1。 图1 CodeArts Check配置界面 表1 CodeArts Check配置界面功能说明 序号 功能项 功能描述 1 开启/关闭无感扫描和git提交自动扫描 配置无感扫描:即勾选“代码编辑后保存,是否自动触发代码检查”。扫描完成不影响
配置代码检查任务质量门禁 根据质量要求设置门禁阈值,即可了解您的项目是否已准备好投入生产。例如,实际的检查结果超出设置的门禁阈值,则表示当前项目还不具备生产条件。 门禁质量设置支持租户级、项目级以及任务级,优先级为租户级 > 项目级 > 任务级。入口分别如下: 租户级:进入代码检
个人数据保护 通过控制个人数据访问权限以及记录操作日志等方法防止个人数据泄露,保证您的个人数据安全。 权限控制 隐私数据保护 涉及到用户的数据库账号信息需要存储时,提供敏感数据加密存储。 - 数据清理 检查任务执行过程中的敏感数据,检查完成后立即清理。 - 数据备份 支持用户数据备份。
单击左侧导航栏的图标,选择“开发与运维 > 代码检查 CodeArts Check”。 在页面订单列表中,单击待续费订单右上角“续费”。 进入“续费”页面,根据续费时长,判断是否勾选“统一到期日”,将资源到期时间统一到各个月的某一天(详细介绍请参见统一包年/包月资源的到期日)。确认配置费用后单击“去支付”。
GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。