检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必读 欢迎使用代码检查服务（CodeArts Check）。代码检查是基于云端实现代码质量管理的服务，软件开发者可在编码完成后执行多语言的代码静态检查和安全检查，获取全面的质量报告，并提供缺陷的分组查看与改进建议，有效管控代码质量，帮助产品成功。 您可以使用本文档提供API
API 任务管理 缺陷管理 规则管理
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括：新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括：问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括：获取规则列表接口、创建自定义规则集、查询规则集列表等。
缺陷管理 查询缺陷概要 查询cmetrics缺陷概要 查询缺陷详情 查询缺陷详情的统计 修改缺陷状态 父主题： API
规则管理 获取规则列表接口 创建自定义规则集 查询规则集列表 查看规则集的规则列表 删除自定义规则集 设置每个项目对应语言的默认规则集配置 查询规则集列表-V3 父主题： API
附录 状态码 错误码 获取项目ID 获取账号ID
如何调用API 构造请求 认证鉴权 返回结果
任务管理 新建检查任务 删除检查任务 查询任务列表 执行检查任务 终止检查任务 查询任务执行状态 历史扫描结果查询 查询任务的已选规则集列表v2 查询任务的已选规则集列表v3 查询任务规则集的检查参数v2 查询任务规则集的检查参数v3 任务配置检查参数 修改任务规则集 查询任务检查失败日志
应用示例 示例1：查询任务列表 示例2：查询缺陷概要
构造请求 本节介绍REST API请求的组成，并以调用IAM服务的管理员创建IAM用户接口为例说明如何调用API。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987 。 请求URI 尽管请求UR
返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请
修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下： 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下： 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置。
认证鉴权 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 Token认证：通过Token认证通用请求。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时，需
错误码 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时，如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时，可以联系华为云客服，并提供错误码，以便我们尽快帮您解决问题。
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。
查询缺陷详情 功能介绍 根据检查任务ID分页查询缺陷结果详情。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-detail 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新
查询缺陷概要 功能介绍 根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/defects-summary 表1 路径参数 参数 是否必选 参数类型 描述 task_id
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID
终止检查任务 功能介绍 根据任务ID终止检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个C
查询cmetrics缺陷概要 功能介绍 根据检查任务ID查询cmetrics缺陷概要。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/metrics-summary 表1 路径参数 参数 是否必选 参数类型 描述
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
