更新时间:2022-06-01 GMT+08:00

添加阈值规则

功能介绍

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

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

命名空间。

metricName

String

指标名称。 取值满足表达式[a-zA-Z_:][a-zA-Z0-9_:]*,即首字符为必须为字母_:,其他字符为字母数字_:,长度为1~255个字符。

period

Integer

统计周期。

alarmLevel

Integer

告警级别。

evaluationPeriods

Integer

连续周期。

comparisonOperator

String

阈值条件表达式。

threshold

String

阈值。

alarmName

String

阈值名称。

dimensions

Array of Dimension objects

指标维度。

unit

String

指标单位。

actionEnabled

Boolean

告警是否启用。

alarmActions

Array of strings

告警动作。

alarmAdvice

String

告警建议。

alarmDescription

String

阈值规则描述。

insufficientDataActions

Array of strings

数据不足动作。

okActions

Array of strings

恢复动作。

表4 Dimension

参数

是否必选

参数类型

描述

name

String

维度名称。

value

String

维度取值。

响应参数

状态码: 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

OK,请求响应成功。

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

状态码

状态码

描述

200

OK,请求响应成功。

400

BadRequest 非法请求。 建议直接修改该请求,不要重试该请求。

401

Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。

403

Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

500

InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。

503

ServiceUnavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。

错误码

请参见错误码