查询事件通知规则
功能介绍
查询事件通知规则。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/cae/notice-rules/{rule_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID。 |
rule_id |
是 |
String |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。
|
X-Enterprise-Project-ID |
否 |
String |
企业项目ID。
说明:
关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
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列表。 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
错误码
请参见错误码。