查询事件通知规则 - ShowNoticeRule

project_id

是

String

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

rule_id

是

String

X-Auth-Token

是

String

用户Token。

• 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。

  • 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Enterprise-Project-ID

否

String

企业项目ID。

• 创建环境时，环境会绑定企业项目ID。

• 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

• 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。

api_version

String

API版本，固定值“v1”，该值不可修改。

kind

String

API类型，固定值“NoticeRule”，该值不可修改。

spec

CreateNoticeRuleRespItem object

请求数据。

id

String

通知规则的唯一标识。

name

String

通知名称。

event_name

String

触发事件名称。

scope

NoticeRuleScope object

生效的通知规则范围。

trigger_policy

TriggerPolicy object

触发策略。

notification

NoticeRuleNotification object

通知的机制。

enable

Boolean

是否启用。

type

String

生效范围的类型。包括environments（对指定环境下所有组件生效），applications（对指定应用下所有组件生效），components（对指定的组件生效）。

environments

Array of strings

生效的环境id列表。

applications

Array of strings

生效的应用id列表。

components

Array of strings

生效的组件id列表。

trigger_type

String

触发类型，accumulative: 累计触发，immediately: 立即触发。

period

Integer

触发周期，选择累计触发时需设置该参数，默认单位为s，支持5分钟、20分钟、1小时、4小时、24小时。

operator

String

比较符，支持'>'和'>='。

count

Integer

触发次数，选择累计触发时需设置该参数。

protocol

String

参数解释：

通知的协议类型。

约束限制：

不涉及。

取值范围：

• email：邮件

• sms：短信

• wechat：企业微信群消息

• dingding：钉钉机器人

默认取值：

不涉及。

extension

extension object

endpoint

String

通知的终端地址。

email协议，接入点必须是邮件地址。

sms协议，接入点必须是一个电话号码。

wechat协议以及钉钉机器人场景，参考获取订阅终端。

企业微信群消息以及钉钉机器人为SMN服务公测功能，需提交工单申请开通。

template

String

通知的模板语言。

ZH，中文。

EN，英文。

sign_secret

String

在使用钉钉场景下，支持用户填写密钥字段。

200

请求成功。