修改静默规则 - UpdateMuteRule
功能介绍
修改静默规则。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
aom:muteRule:update
Write
-
-
-
-
URI
PUT /v2/{project_id}/alert/mute-rules
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。获取方式请参见:获取Token。 |
|
Content-Type |
是 |
String |
消息体的类型(格式)。指定类型为“application/json”。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
create_time |
否 |
Long |
参数解释: 创建静默规则时间。仅支持UTC毫秒级时间戳。例如:2024-10-16 16:03:01需要通过工具转换成UTC毫秒级时间戳:1702759381000。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
desc |
否 |
String |
参数解释: 规则的描述信息。 约束限制: 最多可输入1024个字符。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
match |
否 |
Array<Array<Match>> |
参数解释: 告警规则的匹配条件。 约束限制: 并行条件最大数量为10个,一个并行条件中最多包含10个串行条件,总共支持100个条件。 |
|
mute_config |
是 |
MuteConfig object |
参数解释: 告警规则配置的生效时间。 约束限制: 不涉及。 |
|
name |
是 |
String |
参数解释: 静默规则名称。 约束限制: 名称可以包含大小写字母,数字,特殊字符(_),不能以下划线开头结尾,最大长度为100。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
timezone |
否 |
String |
参数解释: 时区。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
update_time |
否 |
Long |
参数解释: 修改静默规则的时间。仅支持UTC毫秒级时间戳。例如:2024-10-16 16:03:01需要通过工具转换成UTC毫秒级时间戳:1702759381000。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
user_id |
否 |
String |
参数解释: 静默规则创建者用户ID,实际值与项目ID相同,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
key |
是 |
String |
参数解释: 指定按照Metadata中的key进行匹配。 约束限制: 不涉及。 取值范围: 最小长度:1 最大长度:128 默认取值: 不涉及。 |
|
operate |
是 |
String |
参数解释: 指定告警规则匹配的方式。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
value |
是 |
Array of strings |
参数解释: 匹配key对应的value。 约束限制: 不涉及。 取值范围: 数组里元素最小长度:1 数组里元素最大长度:256 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ends_at |
否 |
Long |
参数解释: 静默规则结束时间。仅支持UTC毫秒级时间戳。如果静默规则结束时间为永久,则填写0。例如:2024-10-16 16:03:01需要通过工具转换成UTC毫秒级时间戳:1702759381000。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
scope |
否 |
Array of integers |
参数解释: 静默范围。 约束限制: 当参数type的值为WEEKLY或MONTHLY时,参数scope不能为空。 取值范围: 数组元素最小值:0 数组元素最大值:31 默认取值: 不涉及。 |
|
starts_at |
是 |
Long |
参数解释: 静默规则开始时间。仅支持UTC毫秒级时间戳。例如:2024-10-16 16:03:01需要通过工具转换成UTC毫秒级时间戳:1702759381000。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
type |
是 |
String |
参数解释: 静默规则生效时间类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
响应参数
状态码:204
No Content 表示请求成功,但没有内容返回。
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 非法请求错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
|
error_type |
String |
参数解释: 错误类型。 取值范围: 不涉及。 |
|
trace_id |
String |
参数解释: 请求id。 取值范围: 不涉及。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 非法请求错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
|
error_type |
String |
参数解释: 错误类型。 取值范围: 不涉及。 |
|
trace_id |
String |
参数解释: 请求id。 取值范围: 不涉及。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 非法请求错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
|
error_type |
String |
参数解释: 错误类型。 取值范围: 不涉及。 |
|
trace_id |
String |
参数解释: 请求id。 取值范围: 不涉及。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
响应码。 |
|
error_msg |
String |
响应信息描述。 |
|
trace_id |
String |
响应id。 |
请求示例
修改名称为“32255”、时区为“xxx”和用户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.08012003",
"error_msg" : "request insertParma probably has error",
"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”、时区为“xxx”和用户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 73 74 |
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 UpdateMuteRuleSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); UpdateMuteRuleRequest request = new UpdateMuteRuleRequest(); 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 { UpdateMuteRuleResponse response = client.updateMuteRule(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”、时区为“xxx”和用户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 |
# 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateMuteRuleRequest() 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.update_mute_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) |
修改名称为“32255”、时区为“xxx”和用户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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateMuteRuleRequest{} 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) timezoneMuteRule:= "xxx" descMuteRule:= "" createTimeMuteRule:= int64(1668147671966) request.Body = &model.MuteRule{ UserId: &userIdMuteRule, UpdateTime: &updateTimeMuteRule, Timezone: &timezoneMuteRule, Name: "32255", MuteConfig: muteConfigbody, Match: listMatchbody, Desc: &descMuteRule, CreateTime: &createTimeMuteRule, } response, err := client.UpdateMuteRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
204 |
No Content 表示请求成功,但没有内容返回。 |
|
400 |
BadRequest 非法请求。建议直接修改该请求,不要重试该请求。 |
|
401 |
Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 |
|
403 |
Forbidden 请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
|
500 |
InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 |
错误码
请参见错误码。