修改阈值规则
功能介绍
该接口用于修改一条阈值规则。
调用方法
请参见如何调用API。
URI
PUT /v2/{project_id}/alarm-rules
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。获取方式请参见：获取Token。 |
| Content-Type | 是 | String | 消息体的类型（格式）。指定类型为“application/json”。 枚举值：
|
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| action_enabled | 否 | Boolean | 是否启用通知。 |
| alarm_actions | 否 | Array of strings | 告警状态通知列表。 |
| alarm_advice | 否 | String | 告警清除建议。字符长度为0-255。 最小长度：0 最大长度：255 |
| alarm_description | 否 | String | 阈值规则描述。字符长度为0-1024。 最小长度：0 最大长度：1024 |
| alarm_level | 是 | Integer | 告警级别。1：紧急，2：重要，3：一般，4：提示。 枚举值：
|
| alarm_rule_name | 是 | String | 阈值规则名称。规则名称包含大小写字母、数字、特殊字符（-_）和汉字组成，不能以特殊字符开头或结尾，最大长度为100。 |
| comparison_operator | 是 | String | 超限条件。<：小于阈值。>：大于阈值。<=：小于等于阈值。>=：大于等于阈值。 枚举值：
|
| dimensions | 是 | Array of Dimension objects | 时间序列维度列表。可通过调用查询时间序列接口，查询当前监控的时间序列名称的时间序列维度列表。 |
| evaluation_periods | 是 | Integer | 间隔周期。 |
| is_turn_on | 否 | Boolean | 阈值规则是否启用。 |
| insufficient_data_actions | 否 | Array of strings | 数据不足通知列表。 |
| metric_name | 是 | String | 时间序列名称。名称长度取值范围为1~255个字符。 |
| namespace | 是 | String | 时间序列命名空间。 |
| ok_actions | 否 | Array of strings | 正常状态通知列表。 |
| period | 是 | Integer | 统计周期。60000：一分钟。300000：五分钟。900000：十五分钟。3600000：一小时。 枚举值：
|
| statistic | 是 | String | 统计方式。 枚举值：
|
| threshold | 是 | String | 超限值。 |
| unit | 是 | String | 时间序列单位 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| alarm_rule_id | Long | 阈值规则id。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误信息描述。 |
| error_type | String | 错误类型。 |
| trace_id | String | 跟踪编号。主要用于开发人员快速搜索日志，定位问题。当返回的状态码为2xx时，trace_id为空；当返回4xx的状态码时，trace_id不为空。 |
请求示例
修改名称为“testaom”、告警等级为“3”、指标名称为“cpuCoreLimit”且所属命名空间为“PAAS.CONTAINER”的阈值规则
https://{Endpoint}/v2/{project_id}/alarm-rules
{
"action_enabled" : false,
"alarm_actions" : [ ],
"alarm_advice" : "",
"alarm_description" : "",
"alarm_level" : 3,
"alarm_rule_name" : "aom_rule",
"comparison_operator" : ">=",
"dimensions" : [ {
"name" : "appName",
"value" : "rhm-broker"
} ],
"evaluation_periods" : 1,
"insufficient_data_actions" : [ ],
"metric_name" : "cpuCoreLimit",
"namespace" : "PAAS.CONTAINER",
"ok_actions" : [ ],
"period" : 60000,
"statistic" : "average",
"threshold" : 0,
"unit" : "Core"
} 响应示例
状态码：200
OK 请求响应成功。
{
"alarm_rule_id" : 91307490000416600
} 状态码：400
BadRequest 非法请求。建议直接修改该请求，不要重试该请求。
{
"error_code" : "AOM.02002SVCSTG_AMS_4000101",
"error_msg" : "Invalid alarm name",
"error_type" : "BAD_REQUEST",
"trace_id" : ""
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK 请求响应成功。 |
| 400 | BadRequest 非法请求。建议直接修改该请求，不要重试该请求。 |
| 401 | Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 |
| 403 | Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 |
| 500 | InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 |
| 503 | ServiceUnavailable 被请求的服务无效。建议直接修改该请求，不要重试该请求。 |
错误码
请参见错误码。
