更新时间:2025-09-04 GMT+08:00
分享

更新通知配置

功能介绍

更新通知配置。

调用方法

请参见如何调用API

URI

PUT /v1/job/{job_id}/notice

表1 路径参数

参数

是否必选

参数类型

描述

job_id

String

参数解释

填写需要查询构建历史列表的构建任务ID。获取方法:在构建任务详情页,拷贝浏览器URL末尾的32位数字、字母组合的字符串,即为构建任务ID。

约束限制

不涉及。

取值范围

只能是英文字母和数字,长度为32个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token

约束限制

不支持租户全局token,请使用scope为project的region级token。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

notice_type

String

参数解释

通知的类型,分为消息,邮件,企业微信,钉钉,飞书。

约束限制

不涉及。

取值范围

MESSAGE(消息),MAIL(邮件),WECOM(企业微信),DING_TALK(钉钉),FEISHU(飞书)。

默认取值

不涉及。

enabled_event_type_names

Array of strings

参数解释

开启的通知的种类。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

send_switch

String

参数解释

是否开启消息通知。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

param_config

String

参数解释

通知参数配置。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

use_project_notice

String

参数解释

是否使用项目级消息通知设置。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

String

参数解释

返回结果信息。

取值范围

不涉及。

error

String

参数解释

返回错误信息。

取值范围

不涉及。

status

String

参数解释

返回状态信息。

取值范围

● success:表示接口调用成功。

● fail:表示接口调用失败。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

PUT https://{endpoint}/v1/job/48c66c6002964721be537cdc6ce0297b/notice/update

{
  "notice_type" : "MESSAGE",
  "enabled_event_type_names" : [ "buildJobFail", "updateConfigJob", "buildJobSuccess", "deleteJob" ],
  "send_switch" : true,
  "use_project_notice" : true,
  "param_config" : "{\"eventTypeNamesReceivers\":{\"buildJobSuccess\":[\"creator\",\"executor\",\"follower\"],\"buildJobFail\":[\"creator\",\"executor\",\"follower\"]}}"
}

响应示例

状态码:200

OK

{
  "result" : null,
  "error" : null,
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档