检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除检查任务,执行中的任务删除无法再查看 调用方法 请参见如何调用API。 URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header参数 参数 是否必选
应用示例 示例1:查询任务列表 示例2:查询缺陷概要
当前代码安全检查增强包一共有284条规则,涵盖Java语言61个, C++ 语言199个, Go语言8个, Python语言16个。 表1 增强包与普通版本检查能力差异 检测项 OWASP TOP CWE TOP 详细描述 基础版/专业版 代码安全增强包 命令注入 支持 支持
environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"]
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题: API
单击“开始检查”,启动任务。 当页面显示,表示任务执行成功。 如果任务执行失败,请根据页面弹出报错提示排查修改。 查看检查结果 代码检查服务提供检查结果统计,并对检查出的问题提供修改建议,可以根据修改建议优化项目代码。 在代码检查任务中,选择“概览”页签,即可查看任务执行结果统计。 单击“代码问题”页签,即可看到问题列表。
开通”,在弹框中单击“确认”。 页面右上角提示开通进行中,成功开通后系统自动返回控制台。 在“开通记录”页签可查看服务开通记录。 关闭服务 为了避免不必要的计费,若您不再使用代码检查服务,建议您关闭服务。关闭服务后,代码检查任务会被删除,无法再进行检查,服务将停止计费。 登录Co
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
task list error 查询任务列表异常 请联系客服 200 CC.00050002 query task detail error 查询任务详情异常 请联系客服 200 CC.00050003 query templates error 查看任务配置模板异常 请联系客服 200
执行GitCode代码检查任务 在代码检查页面任务列表中,单击“GitCodeCheckTask”代码检查任务所在行。 根据页面提示等待任务执行完成。 查看GitCode代码检查详情 在代码检查页面任务列表中,搜索新建GitCode代码检查任务创建的任务名称。 单击任务名称,查看代码检查详情,包括概览、代码问题、代码度量、检查日志等。
执行通用Git代码检查任务 在代码检查页面任务列表中,单击代码检查任务所在行执行任务。 根据页面提示等待任务执行完成。 查看代码检查结果 在代码检查页面任务列表中,搜索创建通用Git代码检查任务创建的任务名称“CheckTask01”。 单击任务名称,查看代码检查详情,包括概览、代码问题、代码度量、检查日志等。
在页面上方选择“费用 > 续费管理”,进入“续费管理”页面。 自定义查询条件。 可在“自动续费项”页签查询已经开通自动续费的资源。 可对“手动续费项”、“到期转按需项”、“到期不续费项”页签的资源开通自动续费。 在列表中找到待续费的订单,单击“操作”列“开通自动续费”。 选择续费时长
代码检查服务支持多种语言的规则集,且每种语言类型对应多种不同级别的规则集,系统规则集列表请参见表1。 多个编译语言的规则集不能选择一起同时检查。例如:C#语言规则集不可与其它语言规则集进行混合检查。 表1 预置规则集 语言 系统规则集类型 默认规则集 支持扫描文件后缀 扩展参数支持的编译工具版本
使用自定义规则集执行检查任务 配置代码检查任务使用带有自定义规则的自定义规则集。 8 查看检查结果 查看检查结果,确认使用的规则是否生效。 创建代码检查任务所属项目 使用华为云账号登录华为云控制台页面。 单击页面左上角,在服务列表中选择“开发与运维 > 软件开发生产线 CodeArts”。 单击“
代码检查对用户操作进行访问控制的方式如下: 角色权限控制:对代码检查任务、规则集的增删改查,规则查看,问题单的创建和导入导出等都均需获得对应的角色及权限。 细粒度权限控制:查询租户项目、设置项目创建者、管理租户项目成员列表等操作需要获得IAM细粒度授权。 父主题: 安全
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题: API
您可以根据”严重程度/文件分类/规则分类”筛选查看告警。 按文件分类查看:打开CodeArts Check窗口,选择“Defects”页签,在检查结果区域左侧工具栏,单击(分类),选择“按文件分类进行查看”。 按严重级别后告警类型查看:打开CodeArts Check窗口,选择“
进入代码检查页面,在任务列表中,单击任务名称。 进入“代码检查详情”页面,选择“设置 > 通知管理”。 根据需要开启或关闭事件类型的通知状态。 开启服务动态通知,即通知当前任务所属项目的特定成员,可在消息中心查看消息。 开启邮件通知,即通知当前任务所属项目的特定成员,可在邮件中查看消息。 配置代码检查服务钉钉通知
助力企业成功。 产品形态包括:云服务和IDE插件。同时,还提供具有深度检查能力的代码检查安全增强包。 云服务代码检查功能列表 表1 云服务代码检查功能列表 功能 描述 编码问题检查 用编码问题检查规则集,对自己的代码进行编码问题缺陷检查。 代码安全检查 用代码安全检查规则集,对自己的代码进行代码安全风险和缺陷检查。
代码检查服务入门实践 当用户开通代码检查服务后,可以根据不同的业务场景灵活使用。 本文介绍常见的代码检查实践。 表1 代码检查服务常用最佳实践 实践 描述 使用系统预置规则检查通用Git代码仓中的代码质量 以通用Git代码源为例,介绍如何创建通用Git代码检查任务。