：SearchAlertRules

请求参数

RegionId和SystemRegionId的映射关系。

SearchAlertRules接口会根据设置的SystemRegionId参数获取指定报警地域的报警规则。

• 如果SystemRegionId参数未设置，后端会自动同步SystemRegionId值为RegionId值。
• 如果设置了SystemRegionId参数，RegionId则必须根据以下映射关系设置，否则将无法返回数据。

例如：需要获取上海地域的报警数据，可以进行以下设置：

• 设置RegionId为cn-shanghai，不设置SystemRegionId参数。
• 设置RegionId为cn-hangzhou，设置SystemRegionId为cn-shanghai。

如果您需要查询法兰克福地域的报警规则，请设置RegionId为eu-west-1，设置SystemRegionId为eu-central-1。

返回数据

报警指标取值枚举

• 报警类型（metricParam.type）：TXN（应用监控入口调用量）
  • 此类报警维度（dimensions.key）：rpc（接口名称）
  • 此类报警数据请求指标（alertRule.rules.measure）：
    • appstat.txn.rt：入口调用响应时间（毫秒）
    • appstat.txn.count：入口调用次数
    • appstat.txn.errcount：入口调用错误次数
• 报警类型（metricParam.type）：TXN_TYPE（应用监控调用类型统计）
  • 此类报警维度（dimensions.key）：rpcType（接口调用类型，如HTTP、DUBBO）
  • 此类报警数据请求指标（alertRule.rules.measure）：
    • appstat.inbound.rt：应用提供服务调用响应时间（毫秒）
    • appstat.inbound.count：应用提供服务调用次数
    • appstat.inbound.error：应用提供服务调用错误数
    • appstat.outbound.rt：应用依赖服务调用响应时间（毫秒）
    • appstat.outbound.count：应用依赖服务调用次数
    • appstat.outbound.error：应用依赖服务调用错误数
• 报警类型（metricParam.type）：DB（数据库指标）
  • 此类报警维度（dimensions.key）：endpoint（数据库名称）
  • 此类报警数据请求指标（alertRule.rules.measure）：
    • appstat.database.rt：数据库调用响应时间（毫秒）
    • appstat.database.count：数据库调用次数
    • appstat.database.errcount：数据库调用错误次数
• 报警类型（metricParam.type）：JVM（JVM监控）
  • 此类报警维度（dimensions.key）：rootIp（机器IP地址）
  • 此类报警数据请求指标（alertRule.rules.measure）：
    • appstat.jvm.heap_used：JVM堆内总内存量（字节）
    • appstat.jvm.GcPsScavengeCount：JVM垃圾回收次数
    • appstat.jvm.GcPsMarkSweepCount：JVM标记清除次数
    • appstat.jvm.GcG1OldGenCount：JVM_Old区G1GC次数
    • appstat.jvm.GcG1YoungGenCount：JVM_Young区G1GC次数
    • appstat.jvm.gc.YoungGcCountInstant：JVM_YoungGC次数
    • appstat.jvm.gc.OldGcCountInstant：JVM_FullGC次数
    • appstat.jvm.gc.YoungGcTimeInstant：JVM_YoungGC耗时（毫秒）
    • appstat.jvm.gc.OldGcTimeInstant：JVM_FullGC耗时（毫秒）
    • appstat.jvm.ThreadCount：JVM_线程总数
    • appstat.jvm.non_heap_used：JVM非堆总使用内存量（字节）
    • appstat.jvm.non_heap_max：JVM非堆内存最大值（字节）
    • appstat.jvm.non_heap_init：JVM非堆内存初始值（字节）
    • appstat.jvm.non_heap_committed：JVM非堆内存提交值（字节）
• 报警类型（metricParam.type）：HOST（主机监控）
  • 此类报警维度（dimensions.key）：rootIp（机器IP地址）
  • 此类报警数据请求指标（alertRule.rules.measure）：
    • appstat.jvm.SystemCpuUser：节点机用户使用CPU（百分比）
    • appstat.jvm.SystemMemFree：节点机空闲内存（字节）
    • appstat.jvm.SystemDiskFree：节点机空闲磁盘（字节）
    • appstat.jvm.SystemNetInErrs：节点机接收错误报文数
    • appstat.jvm.SystemNetOutErrs：节点机发送错误报文数
    • appstat.jvm.SystemLoad：节点机系统负载
• 报警类型（metricParam.type）：EXCEPTION（异常接口调用）
  • 此类报警维度（dimensions.key）：rpc（接口名称）
  • 此类报警数据请求指标（alertRule.rules.measure）：
    • appstat.exception.rt：应用异常接口调用响应时间（毫秒）
    • appstat.exception.count：应用异常接口调用次数

示例

请求示例

http(s)://[Endpoint]/?Action=SearchAlertRules
&Title=AlertRuleTitle
&Type=4
&CurrentPage=1
&PageSize=20
&RegionId=cn-hangzhou
&Pid=atc889zkcf@d8deedfa9bf****
&AppType=TRACE
&SystemRegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SearchAlertRulesResponse>
    <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****</RequestId>
    <PageBean>
        <PageNumber>1</PageNumber>
        <PageSize>20</PageSize>
        <TotalCount>23</TotalCount>
        <AlertRules>
            <Status>RUNNING</Status>
            <UpdateTime>1480521600000</UpdateTime>
            <ContactGroupIdList>381*,572*</ContactGroupIdList>
            <CreateTime>1579508519683</CreateTime>
            <AlertTitle>TestAlertRule</AlertTitle>
            <UserId>113197164949****</UserId>
            <AlertVersion>1</AlertVersion>
            <HostByAlertManager>true</HostByAlertManager>
            <AlertType>4</AlertType>
            <ContactGroupIds>[123, 234]</ContactGroupIds>
            <Config>{\"continuous\":true,\"dataRevision\":2}</Config>
            <RegionId>cn-hangzhou</RegionId>
            <AlertLevel>WARN</AlertLevel>
            <TaskStatus>""</TaskStatus>
            <Title>AlertTest</Title>
            <TaskId>123</TaskId>
            <Id>123</Id>
            <AlertWays>["MAIL", "SMS", "DING_ROBOT"]</AlertWays>
            <AlarmContext>
                <AlarmContentTemplate>报警名称：$报警名称\n筛选条件：$筛选\n报警时间：$报警时间\n报警内容：$报警内容\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！</AlarmContentTemplate>
                <SubTitle>test</SubTitle>
                <AlarmContentSubTitle>TestSubTitle</AlarmContentSubTitle>
                <Content>报警名称：$报警名称\n筛选条件：$筛选\n报警时间：$报警时间\n报警内容：$报警内容\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！</Content>
            </AlarmContext>
            <AlertRule>
                <Operator>|</Operator>
                <Rules>
                    <Measure>appstat.jvm.SystemDiskFree</Measure>
                    <Value>30</Value>
                    <Aggregates>AVG</Aggregates>
                    <NValue>5</NValue>
                    <Operator>CURRENT_GTE</Operator>
                    <Alias>调用响应时间_ms</Alias>
                </Rules>
            </AlertRule>
            <MetricParam>
                <Type>DB</Type>
                <AppGroupId>DEFAULT</AppGroupId>
                <AppId>123</AppId>
                <Pid>9870ca99-8105-4da7-a3a4-d72dd1b1****</Pid>
                <Dimensions>
                    <Key>rootIp</Key>
                    <Type>DISABLED</Type>
                    <Value>"127.0.0.1"</Value>
                </Dimensions>
            </MetricParam>
            <Notice>
                <EndTime>1480607940000</EndTime>
                <NoticeEndTime>1480607940000</NoticeEndTime>
                <StartTime>1480521600000</StartTime>
                <NoticeStartTime>1480521600000</NoticeStartTime>
            </Notice>
        </AlertRules>
    </PageBean>
</SearchAlertRulesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "34ED024E-9E31-434A-9E4E-D9D15C3****",
  "PageBean" : {
    "PageNumber" : 1,
    "PageSize" : 20,
    "TotalCount" : 23,
    "AlertRules" : {
      "Status" : "RUNNING",
      "UpdateTime" : 1480521600000,
      "ContactGroupIdList" : "381*,572*",
      "CreateTime" : 1579508519683,
      "AlertTitle" : "TestAlertRule",
      "UserId" : "113197164949****",
      "AlertVersion" : 1,
      "HostByAlertManager" : true,
      "AlertType" : 4,
      "ContactGroupIds" : "[123, 234]",
      "Config" : "{\\\"continuous\\\":true,\\\"dataRevision\\\":2}",
      "RegionId" : "cn-hangzhou",
      "AlertLevel" : "WARN",
      "TaskStatus" : "\"\"",
      "Title" : "AlertTest",
      "TaskId" : 123,
      "Id" : 123,
      "AlertWays" : "[\"MAIL\", \"SMS\", \"DING_ROBOT\"]",
      "AlarmContext" : {
        "AlarmContentTemplate" : "报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！",
        "SubTitle" : "test",
        "AlarmContentSubTitle" : "TestSubTitle",
        "Content" : "报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！"
      },
      "AlertRule" : {
        "Operator" : "|",
        "Rules" : {
          "Measure" : "appstat.jvm.SystemDiskFree",
          "Value" : 30,
          "Aggregates" : "AVG",
          "NValue" : 5,
          "Operator" : "CURRENT_GTE",
          "Alias" : "调用响应时间_ms"
        }
      },
      "MetricParam" : {
        "Type" : "DB",
        "AppGroupId" : "DEFAULT",
        "AppId" : 123,
        "Pid" : "9870ca99-8105-4da7-a3a4-d72dd1b1****",
        "Dimensions" : {
          "Key" : "rootIp",
          "Type" : "DISABLED",
          "Value" : "\"127.0.0.1\""
        }
      },
      "Notice" : {
        "EndTime" : 1480607940000,
        "NoticeEndTime" : 1480607940000,
        "StartTime" : 1480521600000,
        "NoticeStartTime" : 1480521600000
      }
    }
  }
}