添加阈值规则
功能介绍
该接口用于添加一条阈值规则。
URI
POST /v2/{project_id}/alarm-rules
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
Content-Type |
是 |
String |
指定类型为application/json。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
alarm_advice |
否 |
String |
告警清除建议。 |
alarm_description |
否 |
String |
阈值规则描述。 |
alarm_level |
是 |
Integer |
告警级别。取值范围为[1,4],1：紧急，2：重要，3：次要，4：提示 |
alarm_rule_name |
是 |
String |
阈值规则名称。名称不能包含$>+<;#";&?%=' |
comparison_operator |
是 |
String |
极限条件。取值范围为">", ">=", "<", "<=" |
dimensions |
是 |
Array of Dimension objects |
时间序列维度。 |
evaluation_periods |
是 |
Integer |
间隔周期。取值范围为[1,5] |
is_turn_on |
否 |
Boolean |
阈值规则是否启用。 |
metric_name |
是 |
String |
时间序列名称。取值范围 名称长度为1~255个字符 |
namespace |
是 |
String |
时间序列命名空间。 |
period |
是 |
Integer |
统计周期。取值范围为 60000, 300000, 900000, 3600000 |
statistic |
是 |
String |
统计方式。取值范围 "maximum","minimum","average", "sum","sampleCount" |
threshold |
是 |
String |
临界值。字符串长度不超过255，可被解析为正的数字 |
unit |
否 |
String |
阈值单元。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
alarm_rule_id |
Long |
阈值规则id。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误信息描述。 |
error_type |
String |
错误类型。 |
请求示例
添加一条阈值规则。
POST https://{Endpoint}/v2/{project_id}/alarm-rules
{
"id_turn_on" : true,
"alarm_advice" : "",
"alarm_description" : "",
"alarm_level" : 3,
"alarm_rule_name" : "aaaaaaaa",
"comparison_operator" : ">=",
"dimensions" : [ {
"name" : "appName",
"value" : "rhm-broker"
} ],
"evaluation_periods" : 1,
"metric_name" : "cpuCoreLimit",
"namespace" : "PAAS.CONTAINER",
"period" : 60000,
"statistic" : "average",
"threshold" : 0,
"unit" : "Core"
}
响应示例
状态码： 200
OK
请求响应成功。
{
"alarm_rule_id" : [ ]
}
状态码： 400
BadRequest
非法请求。建议直接修改该请求,不要重试该请求。
{
"error_code" : "AOM.02001500",
"error_msg" : "internal server error",
"error_type" : "INTERNAL_SERVER_ERROR"
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK 请求响应成功。 |
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
401 |
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
503 |
ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。
