添加阈值规则
功能介绍
该接口用于添加一条阈值规则。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/alarm-rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
Content-Type |
是 |
String |
指定类型为application/json。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action_enabled |
否 |
Boolean |
是否启用通知。 |
alarm_actions |
否 |
Array of strings |
告警状态通知列表。 |
alarm_advice |
否 |
String |
告警清除建议。 最小长度:0 最大长度:255 |
alarm_description |
否 |
String |
阈值规则描述。 最小长度: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 |
间隔周期。 最小值:1 最大值:5 |
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不为空。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误信息描述。 |
error_type |
String |
错误类型。 |
trace_id |
String |
跟踪编号。主要用于开发人员快速搜索日志,定位问题。当返回的状态码为2xx时,trace_id为空;当返回4xx的状态码时,trace_id不为空。 |
请求示例
添加一条名称为“testaom”、告警等级为“3”、所属命名空间为“PAAS.CONTAINER”且以“average”形式计算的阈值规则。
https://{Endpoint}/v2/{project_id}/alarm-rules { "is_turn_on" : true, "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" : 1134050083814244400 }
状态码: 400
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.02001102", "error_msg" : "this Threshold rule name has been existed", "error_type" : "BAD_REQUEST", "trace_id" : "" }
状态码: 500
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
{ "error_code" : "AOM.02001500", "error_msg" : "internal server error", "error_type" : "INTERNAL_SERVER_ERROR", "trace_id" : "" }
SDK代码示例
SDK代码示例如下。
添加一条名称为“testaom”、告警等级为“3”、所属命名空间为“PAAS.CONTAINER”且以“average”形式计算的阈值规则。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.aom.v2.region.AomRegion; import com.huaweicloud.sdk.aom.v2.*; import com.huaweicloud.sdk.aom.v2.model.*; import java.util.List; import java.util.ArrayList; public class AddAlarmRuleSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); AddAlarmRuleRequest request = new AddAlarmRuleRequest(); AlarmRuleParam body = new AlarmRuleParam(); List<Dimension> listbodyDimensions = new ArrayList<>(); listbodyDimensions.add( new Dimension() .withName("appName") .withValue("rhm-broker") ); body.withUnit("Core"); body.withThreshold("0"); body.withStatistic(AlarmRuleParam.StatisticEnum.fromValue("average")); body.withPeriod(AlarmRuleParam.PeriodEnum.NUMBER_60000); body.withNamespace("PAAS.CONTAINER"); body.withMetricName("cpuCoreLimit"); body.withIsTurnOn(true); body.withEvaluationPeriods(1); body.withDimensions(listbodyDimensions); body.withComparisonOperator(AlarmRuleParam.ComparisonOperatorEnum.fromValue(">=")); body.withAlarmRuleName("aom_rule"); body.withAlarmLevel(AlarmRuleParam.AlarmLevelEnum.NUMBER_3); body.withAlarmDescription(""); body.withAlarmAdvice(""); body.withActionEnabled(false); request.withBody(body); try { AddAlarmRuleResponse response = client.addAlarmRule(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
添加一条名称为“testaom”、告警等级为“3”、所属命名空间为“PAAS.CONTAINER”且以“average”形式计算的阈值规则。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v2.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = AddAlarmRuleRequest() listDimensionsbody = [ Dimension( name="appName", value="rhm-broker" ) ] request.body = AlarmRuleParam( unit="Core", threshold="0", statistic="average", period=60000, namespace="PAAS.CONTAINER", metric_name="cpuCoreLimit", is_turn_on=True, evaluation_periods=1, dimensions=listDimensionsbody, comparison_operator=">=", alarm_rule_name="aom_rule", alarm_level=3, alarm_description="", alarm_advice="", action_enabled=False ) response = client.add_alarm_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
添加一条名称为“testaom”、告警等级为“3”、所属命名空间为“PAAS.CONTAINER”且以“average”形式计算的阈值规则。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.AddAlarmRuleRequest{} var listDimensionsbody = []model.Dimension{ { Name: "appName", Value: "rhm-broker", }, } isTurnOnAlarmRuleParam:= true alarmDescriptionAlarmRuleParam:= "" alarmAdviceAlarmRuleParam:= "" actionEnabledAlarmRuleParam:= false request.Body = &model.AlarmRuleParam{ Unit: "Core", Threshold: "0", Statistic: model.GetAlarmRuleParamStatisticEnum().AVERAGE, Period: model.GetAlarmRuleParamPeriodEnum().E_60000, Namespace: "PAAS.CONTAINER", MetricName: "cpuCoreLimit", IsTurnOn: &isTurnOnAlarmRuleParam, EvaluationPeriods: int32(1), Dimensions: listDimensionsbody, ComparisonOperator: model.GetAlarmRuleParamComparisonOperatorEnum().GREATER_THAN_OR_EQUAL_TO, AlarmRuleName: "aom_rule", AlarmLevel: model.GetAlarmRuleParamAlarmLevelEnum().E_3, AlarmDescription: &alarmDescriptionAlarmRuleParam, AlarmAdvice: &alarmAdviceAlarmRuleParam, ActionEnabled: &actionEnabledAlarmRuleParam, } response, err := client.AddAlarmRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功。 |
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
401 |
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
503 |
ServiceUnavailable 被请求的服务无效。建议直接修改该请求,不要重试该请求。 |
错误码
请参见错误码。