检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览。 在调用代码检查API之前，请确保已经充分了解代码检查基本概念。详细信息请参见产品介绍。 终端节点 终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，服务的终端节点信息可参考地区和终端节点。 代码检查的终端节点如表1所示，请您根据业务需要选择对应区域的终端节点。
任务id task_name String 任务名字 creator_id String 创建者id git_url String 代码仓地址 git_branch String 代码仓分支,如果是MR模式，为源分支 last_check_time String 上一次检查时间 code_line_total
任务id task_name String 任务名字 creator_id String 创建者id git_url String 代码仓地址 git_branch String 代码仓分支 last_check_time String 上一次检查时间 last_exec_time
使用自定义规则检查CodeArts Repo代码仓中的代码质量 应用场景 随着现在项目的代码量越来越大，以及现有开发框架的增加，静态分析所需要覆盖的场景也日益增多，存在的问题如下： 传统静态分析引擎靠工具提供通用规则来对常见安全，风格和质量场景下的编码问题进行扫描分析，难以实时覆盖不同用户特定场景下的代码问题。
删除自定义规则集 功能介绍 删除自定义规则集，正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
删除检查任务 功能介绍 删除检查任务，执行中的任务删除无法再查看 调用方法 请参见如何调用API。 URI DELETE /v2/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 检查任务ID 请求参数 表2 请求Header参数
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个C
设置每个项目对应语言的默认规则集配置 功能介绍 设置每个项目对应语言的默认规则集配置。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/ruleset/{ruleset_id}/{language}/default 表1 路径参数 参数 是否必选
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID
获取任务的目录树 功能介绍 获取任务的目录树 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/listpathtree 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目
任务配置高级配置 功能介绍 任务配置高级配置，如自定义镜像 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
任务配置屏蔽目录 功能介绍 任务配置屏蔽目录 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-ignorepath 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
修改任务规则集 功能介绍 修改任务规则集。 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/ruleset 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个Cod
任务配置检查参数 功能介绍 任务配置检查参数 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/tasks/{task_id}/config-parameters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
应用场景 Web应用安全检查 应用：使用规则集对Web开发语言进行代码检视，并为开发角色提供修复建议，比如修改的代码位置、系统、语言、模块、引擎等。 场景特点：Web服务面向Internet互联网，容易遭受DDos攻击、信息泄露等风险。 适用场景：互联网服务交付安全等级验收。 项目质量控制
创建自定义规则集 功能介绍 可根据需求灵活的组合规则。 调用方法 请参见如何调用API。 URI POST /v2/ruleset 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token
户的安全责任在于对使用的IaaS、PaaS和SaaS类云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统，虚拟防火墙、API网关和高级安全服务，各项云服务，租户数据，以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮
支持五大业界主流标准和华为编程规范 支持五大业界主流标准和华为编程规范，提升产品代码规范度 软件产品的质量问题往往导致产品产生不可接受的运营风险或过度成本，因此在源代码级别建立质量检测措施的标准是非常重要的，业界如ISO/IEC 5055标准、CERT编程规范等。 使用代码检查服务，可以对您的代码进行全面的质量检查。
基本概念 表1 代码检查服务基本概念 词汇 定义 重复率 重复行数是指涉及至少一次重复的代码行数；重复块是指包含重复行的代码块（最小重复块定义：Java语言连续10行重复，其它语言10行中连续100个字符重复算一个重复块）；重复率=重复行/代码总行数（不包含空行与注释）。 规则
查询审计日志 云审计服务是安全解决方案中专业的日志审计服务，记录了CodeArts Check的相关操作事件，方便您日后的查询、审计和回溯。 支持审计日志的操作 表1 云审计服务支持CodeArts Check服务操作 操作名称 资源类型 事件名称 创建代码检查任务 task create
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
