检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
请参见如何调用API。 URI POST /v2/tasks/{task_id}/run 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID
Check）。代码检查是基于云端实现代码质量管理的服务，软件开发者可在编码完成后执行多语言的代码静态检查和安全检查，获取全面的质量报告，并提供缺陷的分组查看与改进建议，有效管控代码质量，帮助产品成功。 您可以使用本文档提供API对代码检查进行相关操作，如创建、删除、查询任务等。支持的全部操作请参见API概览。 在调
务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 响应参数
请参见如何调用API。 URI PUT /v2/tasks/{task_id}/ruleset 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID
根据项目ID、语言等条件查询规则集列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/rulesets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，每个CodeArts首页下的项目都有1个唯一的项目ID 表2 Query参数
获取规则列表接口 功能介绍 根据语言、问题级别等条件查询规则列表。 调用方法 请参见如何调用API。 URI GET /v2/rules 表1 Query参数 参数 是否必选 参数类型 描述 rule_languages 否 String 规则对应的语言 rule_severity
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中“{Endpoint}”为IAM的终端节点，可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
获取账号ID 在调用接口的时候，部分URL中需要填入账号ID，所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下： 登录管理控制台。 鼠标悬停在右上角的用户名，在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面，即可查看账号ID。 父主题： 附录
文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下： 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下： 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置。 增加任务配置高级配置。
附录 状态码 错误码 获取项目ID 获取账号ID Cmetrics工具规格说明
应用示例 示例1：查询任务列表 示例2：查询缺陷概要
错误码 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时，如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时，可以联系华为云客服，并提供错误码，以便我们尽快帮您解决问题。
返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。使用GET和POST请求查看。
本章节指导用户根据检查任务ID查询缺陷结果的概要，包括问题概述、问题状态、圈复杂度、代码重复率等。 约束限制 任务存在。 涉及接口 涉及的接口如下： 查询缺陷概要：查询缺陷概要，包括问题概述、问题状态、圈复杂度、代码重复率等。 操作步骤 接口相关信息 URI格式：GET /v2/t
本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 约束限制 无。 涉及接口 涉及的接口如下： 查询任务列表：根据DEVCLOUD_PROJECT_UUID查询任务列表。 操作步骤 查询任务列表。 接口相关信息 URI格式：GET /v2/{project_id}/tasks
身份认证与访问控制 身份认证 用户访问代码检查服务的方式有多种，包括代码检查用户界面、API、SDK，无论访问方式封装成何种形式，其本质都是通过代码检查提供的REST风格的API接口进行请求。 代码检查的接口需要经过认证请求后才可以访问成功。代码检查支持两种认证方式： Token
入门 从0到1，快速学习代码检查服务。 快速入门 代码检查基本流程 04 API 通过代码检查开放的API和调用示例，您可以对任务、缺陷、规则等进行管理。 API文档 使用前必读 API概览 如何调用API 附录 常见问题 了解更多常见问题、案例和解决方案 热门案例 执行代码检查任务时提示：no
在工具版本升级后，由于代码检查服务检查引擎的能力提升，可能会出现新的缺陷。但新检查出来的缺陷，不会计算到正式缺陷中，开发者拥有60天的缓冲周期对代码进行修改，周期内没有修改或者屏蔽的缺陷，在周期结束后后会计算到正式缺陷中。 执行计划 定义代码检查任务自动触发的方式。通过触发器，使代码检查的自动化执行更加灵活易用。
实践检查第三方代码仓的代码质量，代码检查服务需通过CodeArts提供的扩展插件连接到第三方代码仓。 创建通用Git代码检查任务并获取任务ID 创建代码检查任务并获取任务ID。 创建访问凭证AK和SK 创建调用API时使用的AK和SK。 下载KooCLI工具并获取代码检查API的调用命令
全部 代码检查 计费说明 规则集设置 任务设置 API 代码检查 CodeArts Check（原CodeCheck）是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力，提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量，助力企业成功。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
