更新通知规则
功能介绍
更新对应指标的通知规则;对应指标满足相应的规则条件时发送通知。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
PUT /v2/{project_id}/statistics/notify-rules/{rule_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
rule_id |
是 |
String |
通知规则ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
metric_name |
否 |
String |
统计指标名称，目前仅支持固定值：desktop_idle_duration 同一指标的规则不允许重复
|
|
threshold |
否 |
Integer |
规则配置-阈值(天)。 |
|
comparison_operator |
否 |
String |
统计指标对应的统计值和threshold进行比较的条件
|
|
interval |
否 |
Integer |
触发通知后；下次通知的间隔时间;默认每天一次 |
|
enable |
否 |
Boolean |
启禁用规则 true:启用 false:禁用。 |
|
notify_object |
否 |
String |
通知对象;smn的主题urn。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
rule_id |
String |
规则ID。 |
|
metric_name |
String |
统计指标名称，目前仅支持固定值：desktop_idle_duration
|
|
threshold |
Integer |
统计持续周期(天)。 |
|
comparison_operator |
String |
统计指标对应的统计值和threshold进行比较的条件
|
|
interval |
Integer |
触发通知后；下次通知的间隔时间;默认每天一次 |
|
enable |
Boolean |
启禁用规则 true:启用 false:禁用。 |
|
notify_object |
String |
通知对象;smn的主题urn。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
{
"metric_name" : "desktop_idle_duration",
"threshold" : 30,
"comparison_operator" : ">=",
"interval" : 1,
"enable" : true,
"notify_object" : "urn:smn:REGION_ID:XXX-XXX-XXX:topicName"
}
响应示例
状态码：200
响应成功。
{
"rule_id" : "xxxx-xxxx-xxxx",
"metric_name" : "desktop_idle_duration",
"threshold" : 30,
"comparison_operator" : "",
"interval" : 1,
"enable" : true,
"notify_object" : "urn:smn:REGION_ID:XXX-XXX-XXX:topicName"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
响应成功。 |
|
400 |
客户端请求有误。 |
|
401 |
鉴权失败。 |
|
500 |
内部错误。 |
错误码
请参见错误码。
