本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 应用运维管理 AOM/ API参考（吉隆坡区域）/ API/ 告警/ 获取静默规则列表

获取静默规则列表

更新时间：2024-08-02 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

获取静默规则列表。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/alert/mute-rules

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户从IAM申请到的projectid，一般为32位字符串。最小长度：32 最大长度：32

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM服务获取的用户Token。最小长度：1 最大长度：40960
Content-Type	是	String	指定类型为application/json。枚举值： application/json

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
[数组元素]	Array of MuteRule objects	OK 请求响应成功。

表4 MuteRule
参数	参数类型	描述
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

表5 Match
参数	参数类型	描述
key	String	指定按照Metadata中的key进行匹配最小长度：1 最大长度：128
operate	String	指定匹配的方式：EXIST:存在，REGEX:正则，EQUALS:等于最小长度：1 最大长度：100 枚举值： EQUALS REGEX EXIST
value	Array of strings	要匹配的key对应的value，当operate为存在时，此值为空最小长度：1 最大长度：256 数组长度：0 - 5

表6 MuteConfig
参数	参数类型	描述
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 枚举值： FIXED DAILY WEEKLY MONTHLY

状态码： 401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码最小长度：12 最大长度：12
error_msg	String	错误信息最小长度：0 最大长度：1024
error_type	String	错误类型最小长度：0 最大长度：128
trace_id	String	请求id 最小长度：32 最大长度：32

状态码： 403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码最小长度：12 最大长度：12
error_msg	String	错误信息最小长度：0 最大长度：1024
error_type	String	错误类型最小长度：0 最大长度：128
trace_id	String	请求id 最小长度：32 最大长度：32

状态码： 500

表9 响应Body参数
参数	参数类型	描述
error_code	String	响应码。最小长度：13 最大长度：13
error_msg	String	响应信息描述。最小长度：1 最大长度：100
trace_id	String	响应id。最小长度：12 最大长度：12

请求示例

获取静默规则列表

https://{Endpoint}/v2/{project_id}/alert/mute-rules

响应示例

状态码： 200

OK 请求响应成功。

[ {
  "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" : "2a473356cca5487f8373be891bffc1cf"
} ]

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

状态码

状态码	描述
200	OK 请求响应成功。
401	Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。
403	Forbidden 请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。
500	InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。

错误码

请参见错误码。

父主题： 告警

上一篇：修改静默规则

下一篇：通过规则名称获取告警行动规则

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

获取静默规则列表

功能介绍

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

意见反馈

文档内容是否对您有帮助？

文档反馈