文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 流水线所有消息通知类型状态查询 - QueryPipelineMessageNoticeStatus
更新时间：2025-11-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

流水线所有消息通知类型状态查询 - QueryPipelineMessageNoticeStatus

功能介绍

查询流水线所有消息通知类型的启用状态

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/api/pipeline-notices/{pipeline_id}/notice/status

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

pipeline_id

是

String

参数解释：

流水线ID，可以通过查询流水线列表接口获取，其中pipelines.pipelineId即为流水线ID。

约束限制：

不涉及。

取值范围：

32位字符，由数字和字母组成。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

type

Integer

参数解释：

流水线消息通知类型。

约束限制：

不涉及。

取值范围：

  • 1：站内信。

  • 2：邮件通知。

  • 3：微信。

  • 4：钉钉。

  • 5：飞书。

  • 6：通用webhook。

默认取值：

不涉及。

enabled

Boolean

参数解释：

是否启用通知。

约束限制：

不涉及。

取值范围：

  • true：启用通知。

  • false：禁用通知。

默认取值：

不涉及。

project_switch

Boolean

参数解释：

是否使用项目级通知配置。

约束限制：

不涉及。

取值范围：

  • true：使用项目级通知。

  • false：使用流水线级通知配置。

默认取值：

不涉及。

can_open

Boolean

参数解释：

是否可以启用通知。

约束限制：

不涉及。

取值范围：

  • true：可以启用。

  • false：不可启用。

默认取值：

不涉及。

状态码：400

表3 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释：

错误信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

请求示例

GET https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-notices/0747d5a7099e45f69dc1d099945909a9/notice/status

响应示例

状态码：200

OK

[ {
  "type" : 5,
  "enabled" : false,
  "project_switch" : false,
  "can_open" : true
}, {
  "type" : 3,
  "enabled" : false,
  "project_switch" : true,
  "can_open" : true
}, {
  "type" : 4,
  "enabled" : false,
  "project_switch" : true,
  "can_open" : true
}, {
  "type" : 1,
  "enabled" : false,
  "project_switch" : false,
  "can_open" : true
}, {
  "type" : 2,
  "enabled" : true,
  "project_switch" : false,
  "can_open" : true
} ]

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 流水线管理

相关文档