本文导读

展开导读

文档首页/ 应用运维管理 AOM/ API参考（安卡拉区域）/ API/ 监控（v1）/ 添加阈值规则

添加阈值规则

更新时间：2024-04-15 GMT+08:00

查看PDF

功能介绍

该接口用于添加一条阈值规则，包括如下工作。

URI

POST /v1/{project_id}/ams/alarms

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户从IAM申请到的projectid，一般为32位字符串。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM获取的用户Project级别Token。
Content-Type	是	String	指定类型为application/json。枚举值： application/json

表3 请求Body参数
参数	是否必选	参数类型	描述
statistic	是	String	统计方式。枚举值： maximum minimum average sum sampleCount
namespace	否	String	指标命名空间。取值范围： PAAS.CONTAINER：组件指标、实例指标、进程指标和容器指标的命名空间 PAAS.NODE：主机指标、网络指标、磁盘指标和文件系统指标的命名空间 PAAS.SLA：SLA指标的命名空间 PAAS.AGGR：集群指标的命名空间自定义指标的命名空间。
metricName	是	String	指标名称。取值满足表达式[a-zA-Z_:][a-zA-Z0-9_:]*，即首字符为必须为字母_:，其他字符为字母数字_:，长度为1~255个字符。
period	是	Integer	统计周期。取值范围为 60000, 300000, 900000, 3600000
alarmLevel	否	Integer	告警级别。
evaluationPeriods	是	Integer	连续周期。
comparisonOperator	是	String	阈值条件表达式。表达式不能为空。表达式内容仅包含>：大于。<：小于。>=：大于等于。<=：小于等于。枚举值： > < >= <=
threshold	是	String	阈值。字符长度小于等于255，不能小于0，不能是正无穷大或负无穷大。
alarmName	是	String	阈值名称。名称不能为空，字符长度不能大于255，不能包含特殊字符"#%&'+;<=>?\
dimensions	是	Array of Dimension objects	指标维度。维度的总字符长度（即数组的json字符串长度）不能大于65535。数组长度不能大于100。
unit	是	String	指标单位。单位不能为空，字符长度不能大于32。
actionEnabled	否	Boolean	告警是否启用。
alarmActions	否	Array of strings	告警动作。数组长度小于等于5，不能包含#，只能以"SMN:"开始。示例："SMN:zh-cn:op_xxx;+08\|00:console.xxx/aom/?agencyId=3402daf6xxxxx0e1&locale=zh-cn&region=xxx$/aom:urn:smn:xxx:06175f8cxxxx391f:aomtest" 解析："SMN:{zh-cn \| en-us}:{domain_name};{timezone}:{console_uri}:{smn_topic_urn}"
alarmAdvice	否	String	告警建议。告警建议字符长度不能大于255。
alarmDescription	否	String	阈值规则描述。规则描述字符长度不能大于1024。
insufficientDataActions	否	Array of strings	数据不足动作。数组长度小于等于5，不能包含#，只能以"SMN:"开始。示例："SMN:zh-cn:op_xxx;+08\|00:console.xxx/aom/?agencyId=3402daf6xxxxx0e1&locale=zh-cn&region=xxx$/aom:urn:smn:xxx:06175f8cxxxx391f:aomtest" 解析："SMN:{zh-cn \| en-us}:{domain_name};{timezone}:{console_uri}:{smn_topic_urn}"
okActions	否	Array of strings	恢复动作。数组长度小于等于5，不能包含#，只能以"SMN:"开始。示例："SMN:zh-cn:op_xxx;+08\|00:console.xxx/aom/?agencyId=3402daf6xxxxx0e1&locale=zh-cn&region=xxx$/aom:urn:smn:xxx:06175f8cxxxx391f:aomtest" 解析："SMN:{zh-cn \| en-us}:{domain_name};{timezone}:{console_uri}:{smn_topic_urn}"

表4 Dimension
参数	是否必选	参数类型	描述
name	是	String	维度名称。维度名称不能为空，字符长度不能大于255。
value	否	String	维度取值。维度取值字符长度不能大于1024。

响应参数

状态码： 200

表5 响应Body参数
参数	参数类型	描述
errorCode	String	响应码。
errorMessage	String	响应信息描述。
alarmId	Long	阈值规则编码。

请求示例

添加一条阈值规则

POST https://{Endpoint}/v1/{project_id}/ams/alarms

{
  "actionEnabled" : false,
  "alarmActions" : [ ],
  "alarmAdvice" : "",
  "alarmDescription" : "",
  "alarmLevel" : 3,
  "alarmName" : "aaaaaaaa",
  "comparisonOperator" : ">=",
  "dimensions" : [ {
    "name" : "appName",
    "value" : "rhm-broker"
  } ],
  "evaluationPeriods" : 1,
  "insufficientDataActions" : [ ],
  "metricName" : "cpuCoreLimit",
  "namespace" : "PAAS.CONTAINER",
  "okActions" : [ ],
  "period" : 60000,
  "statistic" : "average",
  "threshold" : 0,
  "unit" : "Core"
}

响应示例

状态码： 200

请求响应成功。

{
  "errorCode" : "SVCSTG_AMS_2000000",
  "errorMessage" : "success",
  "alarmId" : 12345678
}

状态码

状态码	描述
200	OK 请求响应成功。
400	BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
401	Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。
403	Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
500	InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
503	ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。

错误码

请参见错误码。

父主题： 监控（v1）

上一篇：添加监控数据

下一篇：修改阈值规则

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消