更新触发检查的webhook开关 - UpdateCodeCheckWebhook
功能介绍
根据任务ID设置任务集成服务的合并请求时触发开关和代码提交时触发开关，方便用户在CodeArtsRepo创建MR或者提交代码时自动触发代码检查任务。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
codeartscheck:task:update | Write | task * | - | - | - |
- | codeartscheck:ProjectId |
URI
PUT /v4/tasks/{task_id}/webhook
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
task_id | 是 | String | 参数解释： 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制： 不涉及。 取值范围： 长度为[1~128]个字符。 默认取值： 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
is_set_mr_webhook | 否 | Boolean | 参数解释： 是否打开合并请求时触发代码检查。值是true时为打开，值是false时为关闭。 约束限制： 不涉及。 取值范围：
默认取值： 不涉及。 |
is_set_push_webhook | 否 | Boolean | 参数解释： 是否打开代码提交时触发代码检查。值是true时为打开，值是false时为关闭。 约束限制： 不涉及。 取值范围：
默认取值： 不涉及。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
result | String | 参数解释： 设置成功时返回"CodeArts Repo 集成设置更新成功"。 约束限制： 不涉及。 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
请求示例
修改任务ID为8df8d58f832a408f88e4aebea0ff6fc5的集成服务配置，打开了合并请求时触发，关闭了代码提交时触发。
PUT https://{endpoint}/v4/tasks/8df8d58f832a408f88e4aebea0ff6fc5/webhook
{
"is_set_mr_webhook" : true,
"is_set_push_webhook" : false
} 响应示例
状态码：200
Request succeeded!
{
"result" : "CodeArts Repo 集成设置更新成功"
} 状态码：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 |
错误码
请参见错误码。
