检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
代码检查任务提供了哪些设置？ API 代码检查提供了REST（Representational State Transfer）风格API，支持您通过HTTP/HTTPS请求调用，实现创建、执行、删除、查询、终止检查任务，管理缺陷以及管理规则集等操作。 支持区域： 华北-北京一，华北-北京四，华东-上海一
自定义，支持中文、英文、数字、“-”、“_”、“.”、空格，不超过256个字符。例如：Endpoint01。 Git仓库Url 输入待连接的Git仓库的https地址。 用户名 输入待连接的Git仓库的用户名，不超过300个字符。 密码或Access Token 输入待连接的Git仓库的密码，不超过300个字符。
响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 GET https://{endpoint}/v2/{project_id}/ruleset/{ruleset_id}/rules 响应示例 状态码： 200
响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 请求示例 GET https://{endpoint}/v2/{project_id}/tasks/{task_id}/metrics-summary 响应示例 状态码：
错误码 调用接口出错后，将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时，如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时，可以联系华为云客服，并提供错误码，以便我们尽快帮您解决问题。
返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请
示例1：查询任务列表 场景描述 本章节指导用户根据DEVCLOUD_PROJECT_UUID查询该项目下的任务列表。 约束限制 无。 涉及接口 涉及的接口如下： 查询任务列表：根据DEVCLOUD_PROJECT_UUID查询任务列表。 操作步骤 查询任务列表。 接口相关信息 URI格式：GET
删除自定义规则集 功能介绍 删除自定义规则集，正在使用中的或默认规则集不能删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/ruleset/{ruleset_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
查询任务列表 功能介绍 根据project_id查询该项目下的任务列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，每个Code
修改缺陷状态 功能介绍 修改检查出的缺陷的状态为未解决、已解决、已忽略 调用方法 请参见如何调用API。 URI PUT /v2/tasks/{task_id}/defect-status 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID
执行检查任务 功能介绍 执行检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/run 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 任务ID，即新建检查任务接口的返回值，每个CodeArts
获取任务的目录树 功能介绍 获取任务的目录树 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/listpathtree 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目
获取项目ID 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中“{Endpoint}”为IAM的终端节点，可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
任务配置屏蔽目录 功能介绍 任务配置屏蔽目录 调用方法 请参见如何调用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
示例2：查询缺陷概要 场景描述 本章节指导用户根据检查任务ID查询缺陷结果的概要，包括问题概述、问题状态、圈复杂度、代码重复率等。 约束限制 任务存在。 涉及接口 涉及的接口如下： 查询缺陷概要：查询缺陷概要，包括问题概述、问题状态、圈复杂度、代码重复率等。 操作步骤 接口相关信息
创建自定义规则集 功能介绍 可根据需求灵活的组合规则。 调用方法 请参见如何调用API。 URI POST /v2/ruleset 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 设置媒体类型和编码格式 X-Auth-Token
查询任务执行状态 功能介绍 根据任务ID查询任务执行状态。任务状态：0表示检查中，1表示检查失败，2表示检查成功，3表示任务中止。只有正在检查中才有进度的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/progress 表1 路径参数
状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
