更新触发检查的webhook开关 - UpdateCodeCheckWebhook
功能介绍
打开/关闭触发代码检查的webhook开关
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
|
授权项 |
访问级别 |
资源类型（*为必须） |
条件键 |
别名 |
依赖的授权项 |
|---|---|---|---|---|---|
|
codeartscheck:task:update |
Write |
task * |
- |
- |
- |
|
- |
codeartscheck:ProjectId |
URI
PUT /v4/tasks/{task_id}/webhook
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释： 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有唯一的任务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.00000000",
"error_msg" : "网络繁忙，请稍后再试"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
