文档首页/代码检查 CodeArts Check/API参考/API/任务管理/更新门禁配置 - UpdateCodeGate
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新门禁配置 - UpdateCodeGate

功能介绍

根据任务ID设置任务的致命问题数、严重问题数、一般问题数和提示问题数的质量门禁，在检查完成后，超过门禁阈值将提示门禁结果为Failed。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:update

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

PUT /v1/task/code-gate

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

operator

否

String

参数解释：

操作者。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

reviewData

是

Array of ReviewDataInfoRequestParam objects

参数解释：

任务门禁配置列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

id

是

String

参数解释：

任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

约束限制：

不涉及。

取值范围：

长度为[1~32]个字符。

默认取值：

不涉及。

表3 ReviewDataInfoRequestParam

参数

是否必选

参数类型

描述

compareType

是

String

参数解释：

运算逻辑。

约束限制：

不涉及。

取值范围：

取值为"≤"。

默认取值：

不涉及。

isCheck

是

Integer

参数解释：

门禁开关。

约束限制：

不涉及。

取值范围：

  • 0：关闭门禁。

  • 1：打开门禁。

默认取值：

不涉及。

name

是

String

参数解释：

门禁项。

约束限制：

不涉及。

取值范围：

  • 致命问题数。

  • 严重问题数。

  • 一般问题数。

  • 提示问题数。

默认取值：

不涉及。

value

是

Integer

参数解释：

门禁阈值。

约束限制：

不涉及。

取值范围：

≥0

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

result

String

参数解释：

更新成功时返回"更新门禁配置成功"。

取值范围：

不涉及。

httpStatus

String

参数解释：

HTTP响应状态。

取值范围：

  • OK：请求已成功处理，服务器返回了请求的资源或操作结果。

  • ACCEPTED：请求已被服务器接受，但处理尚未完成（通常用于异步操作）。

  • INTERNAL_SERVER_ERROR：接口内部异常。

  • BAD_REQUEST：参数校验异常。

status

String

参数解释：

接口响应状态。

取值范围：

  • success：接口响应成功。

  • error：接口响应失败。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

修改任务ID为a2825abdc53e4b53ba2226d6531fd09d的门禁配置，致命问题数、严重问题数、一般问题数、提示问题数的门禁都≤0。

PUT https://{endpoint}/v1/task/code-gate

{
  "id" : "a2825abdc53e4b53ba2226d6531fd09d",
  "reviewData" : [ {
    "compareType" : "≤",
    "isCheck" : 1,
    "name" : "致命问题数",
    "value" : 0
  }, {
    "compareType" : "≤",
    "isCheck" : 1,
    "name" : "严重问题数",
    "value" : 0
  }, {
    "compareType" : "≤",
    "isCheck" : 1,
    "name" : "一般问题数",
    "value" : 0
  }, {
    "compareType" : "≤",
    "isCheck" : 1,
    "name" : "提示问题数",
    "value" : 0
  } ]
}

响应示例

状态码：200

Request succeeded!

{
  "httpStatus" : "OK",
  "result" : "更新门禁配置成功",
  "status" : "success"
}

状态码：400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码：401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 任务管理

相关文档