新增静默规则
功能介绍
新增静默规则。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/alert/mute-rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户从IAM申请到的projectid,一般为32位字符串。 最小长度:32 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 最小长度:1 最大长度:40960 |
Content-Type |
是 |
String |
指定类型为application/json。 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
create_time |
否 |
Long |
创建时间 最小值:0 最大值:9999999999999 |
desc |
否 |
String |
规则描述 最小长度:0 最大长度:1024 |
match |
是 |
Array<Array<Match>> |
规则的匹配条件。串行条件和并行条件的最大数量限制为10。 数组长度:1 - 10 |
mute_config |
是 |
MuteConfig object |
规则的生效时间配置 |
name |
是 |
String |
规则名称。名称包含大小写字母、数字、特殊字符(_)、不能以下划线开头或结尾,最大长度为100。 最小长度:1 最大长度:100 |
timezone |
是 |
String |
时区 最小长度:1 最大长度:32 |
update_time |
否 |
Long |
修改时间 最小值:0 最大值:9999999999999 |
user_id |
否 |
String |
用户ID 最小长度:32 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
是 |
String |
指定按照Metadata中的key进行匹配 最小长度:1 最大长度:128 |
operate |
是 |
String |
指定匹配的方式:EXIST:存在,REGEX:正则,EQUALS:等于 最小长度:1 最大长度:100 枚举值:
|
value |
否 |
Array of strings |
要匹配的key对应的value,当operate为存在时,此值为空 最小长度:1 最大长度:256 数组长度:0 - 5 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ends_at |
否 |
Long |
静默规则结束时间 最小值:0 最大值:999999999 |
scope |
否 |
Array of integers |
当type为每周或者每月时,scope不能为空 最小值:0 最大值:31 数组长度:1 - 100 |
starts_at |
是 |
Long |
静默规则开始时间 最小值:0 最大值:999999999 |
type |
是 |
String |
静默规则生效时间种类。FIXED:固定方式统计,DAILY:按日合计,WEEKLY:按周统计,MONTHLY:按月统计 最小长度:1 最大长度:100 枚举值:
|
响应参数
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:12 最大长度:12 |
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
error_type |
String |
错误类型 最小长度:0 最大长度:128 |
trace_id |
String |
请求id 最小长度:32 最大长度:32 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:12 最大长度:12 |
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
error_type |
String |
错误类型 最小长度:0 最大长度:128 |
trace_id |
String |
请求id 最小长度:32 最大长度:32 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:12 最大长度:12 |
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
error_type |
String |
错误类型 最小长度:0 最大长度:128 |
trace_id |
String |
请求id 最小长度:32 最大长度:32 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
响应码。 最小长度:13 最大长度:13 |
error_msg |
String |
响应信息描述。 最小长度:1 最大长度:100 |
trace_id |
String |
响应id。 最小长度:12 最大长度:12 |
请求示例
新增一条名称为"32255",用户id为"2xxxxxxxxxxxxxxxxxxxxxxxxxcf"的静默规则
https://{Endpoint}/v2/{project_id}/alert/mute-rules { "create_time" : 1668147671966, "desc" : "", "match" : [ [ { "key" : "event_severity", "operate" : "EQUALS", "value" : [ "Info" ] } ] ], "mute_config" : { "ends_at" : 86399, "scope" : [ ], "starts_at" : 0, "type" : "DAILY" }, "name" : "32255", "timezone" : "xxx", "update_time" : 1668147671966, "user_id" : "2xxxxxxxxxxxxxxxxxxxxxxxxxcf" }
响应示例
状态码: 400
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.08011001", "error_msg" : "the muteName is exist", "error_type" : "PARAM_INVALID", "trace_id" : "" }
状态码: 401
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。
{ "error_code" : "AOM.0403", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED", "trace_id" : null }
状态码: 403
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
{ "error_code" : "AOM.0403", "error_msg" : "auth failed.", "error_type" : "AUTH_FAILED", "trace_id" : null }
状态码: 500
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。
{ "error_code" : "APM.00000500", "error_msg" : "Internal Server Error", "trace_id" : "" }
SDK代码示例
SDK代码示例如下。
新增一条名称为"32255",用户id为"2xxxxxxxxxxxxxxxxxxxxxxxxxcf"的静默规则
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 71 72 |
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 AddMuteRulesSolution { 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(); AddMuteRulesRequest request = new AddMuteRulesRequest(); MuteRule body = new MuteRule(); MuteConfig muteConfigbody = new MuteConfig(); muteConfigbody.withEndsAt(86399L) .withStartsAt(0L) .withType(MuteConfig.TypeEnum.fromValue("DAILY")); List<String> listMatchValue = new ArrayList<>(); listMatchValue.add("Info"); List<Match> listMatchMatch = new ArrayList<>(); listMatchMatch.add( new Match() .withKey("event_severity") .withOperate(Match.OperateEnum.fromValue("EQUALS")) .withValue(listMatchValue) ); List<List<Match>> listbodyMatch = new ArrayList<>(); listbodyMatch.add(listMatchMatch); body.withUserId("2xxxxxxxxxxxxxxxxxxxxxxxxxcf"); body.withUpdateTime(1668147671966L); body.withTimezone("xxx"); body.withName("32255"); body.withMuteConfig(muteConfigbody); body.withMatch(listbodyMatch); body.withDesc(""); body.withCreateTime(1668147671966L); request.withBody(body); try { AddMuteRulesResponse response = client.addMuteRules(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()); } } } |
新增一条名称为"32255",用户id为"2xxxxxxxxxxxxxxxxxxxxxxxxxcf"的静默规则
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 |
# 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 = AddMuteRulesRequest() muteConfigbody = MuteConfig( ends_at=86399, starts_at=0, type="DAILY" ) listValueMatch = [ "Info" ] listMatchMatch = [ Match( key="event_severity", operate="EQUALS", value=listValueMatch ) ] listMatchbody = [ listMatchMatch ] request.body = MuteRule( user_id="2xxxxxxxxxxxxxxxxxxxxxxxxxcf", update_time=1668147671966, timezone="xxx", name="32255", mute_config=muteConfigbody, match=listMatchbody, desc="", create_time=1668147671966 ) response = client.add_mute_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
新增一条名称为"32255",用户id为"2xxxxxxxxxxxxxxxxxxxxxxxxxcf"的静默规则
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 |
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.AddMuteRulesRequest{} endsAtMuteConfig:= int64(86399) muteConfigbody := &model.MuteConfig{ EndsAt: &endsAtMuteConfig, StartsAt: int64(0), Type: model.GetMuteConfigTypeEnum().DAILY, } var listValueMatch = []string{ "Info", } var listMatchMatch = []model.Match{ { Key: "event_severity", Operate: model.GetMatchOperateEnum().EQUALS, Value: &listValueMatch, }, } var listMatchbody = [][](model.Match){ listMatchMatch, } userIdMuteRule:= "2xxxxxxxxxxxxxxxxxxxxxxxxxcf" updateTimeMuteRule:= int64(1668147671966) descMuteRule:= "" createTimeMuteRule:= int64(1668147671966) request.Body = &model.MuteRule{ UserId: &userIdMuteRule, UpdateTime: &updateTimeMuteRule, Timezone: "xxx", Name: "32255", MuteConfig: muteConfigbody, Match: listMatchbody, Desc: &descMuteRule, CreateTime: &createTimeMuteRule, } response, err := client.AddMuteRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
204 |
OK 添加成功 |
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
401 |
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
错误码
请参见错误码。