SearchAlertRules

请求参数

返回数据

报警指标取值枚举

• 报警类型（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
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<SearchAlertRulesResponse>
	  <PageBean>
		    <TotalCount>1</TotalCount>
		    <PageSize>10</PageSize>
		    <PageNumber>1</PageNumber>
		    <AlertRules>
			      <Status>RUNNING</Status>
			      <AlertVersion>1</AlertVersion>
			      <TaskId>0</TaskId>
			      <MetricParam>
				        <Type>TXN</Type>
				        <AppId>537118</AppId>
				        <AppGroupId>DEFAULT</AppGroupId>
				        <Dimensions>
					          <Type>ALL</Type>
					          <Value></Value>
					          <Key>rpc</Key>
				        </Dimensions>
				        <Pid>9870ca99-8105-4da7-a3a4-d72dd1b1****</Pid>
			      </MetricParam>
			      <Config>{"continuous":false,"dataRevision":2,"ownerId":"1084900439941126"}</Config>
			      <CreateTime>1594195623000</CreateTime>
			      <AlertWays>SMS</AlertWays>
			      <AlertWays>MAIL</AlertWays>
			      <AlertWays>DING_ROBOT</AlertWays>
			      <TaskStatus></TaskStatus>
			      <AlarmContext>
				        <AlarmContentTemplate>报警名称:$报警名称\n筛选条件: $筛选\n报警时间: $报警时间\n报警内容: $报警内容\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！</AlarmContentTemplate>
				        <AlarmContentSubTitle></AlarmContentSubTitle>
			      </AlarmContext>
			      <AlertType>7</AlertType>
			      <ContactGroupIdList>572*</ContactGroupIdList>
			      <Notice>
				        <EndTime>1480607940000</EndTime>
				        <NoticeStartTime>1480521600000</NoticeStartTime>
				        <StartTime>1480521600000</StartTime>
				        <NoticeEndTime>1480607940000</NoticeEndTime>
			      </Notice>
			      <UserId>113197164949****</UserId>
			      <AlertTitle>TestAlertRule</AlertTitle>
			      <UpdateTime>1594195623000</UpdateTime>
			      <AlertLevel>WARN</AlertLevel>
			      <Id>123</Id>
			      <RegionId>cn-hangzhou</RegionId>
			      <AlertRule>
				        <Operator>|</Operator>
				        <Rules>
					          <NValue>5</NValue>
					          <Operator>CURRENT_GTE</Operator>
					          <Aggregates>AVG</Aggregates>
					          <Alias>调用响应时间_ms</Alias>
					          <Measure>appstat.transaction.rt</Measure>
					          <Value>2000</Value>
				        </Rules>
				        <Rules>
					          <NValue>5</NValue>
					          <Operator>CURRENT_GTE</Operator>
					          <Aggregates>AVG</Aggregates>
					          <Alias>调用错误次数</Alias>
					          <Measure>appstat.transaction.error</Measure>
					          <Value>1</Value>
				        </Rules>
			      </AlertRule>
		    </AlertRules>
	  </PageBean>
	  <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3C****</RequestId>
</SearchAlertRulesResponse>

JSON 格式

{
	"PageBean": {
		"TotalCount": 1,
		"PageSize": 10,
		"PageNumber": 1,
		"AlertRules": [
			{
				"Status": "RUNNING",
				"AlertVersion": 1,
				"TaskId": 0,
				"MetricParam": {
					"Type": "TXN",
					"AppId": "537118",
					"AppGroupId": "DEFAULT",
					"Dimensions": [
						{
							"Type": "ALL",
							"Value": "",
							"Key": "rpc"
						}
					],
					"Pid": "9870ca99-8105-4da7-a3a4-d72dd1b1****"
				},
				"Config": "{\"continuous\":false,\"dataRevision\":2,\"ownerId\":\"1084900439941126\"}",
				"CreateTime": 1594195623000,
				"AlertWays": [
					"SMS",
					"MAIL",
					"DING_ROBOT"
				],
				"TaskStatus": "",
				"AlarmContext": {
					"AlarmContentTemplate": "报警名称:$报警名称\n筛选条件: $筛选\n报警时间: $报警时间\n报警内容: $报警内容\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！",
					"AlarmContentSubTitle": ""
				},
				"AlertType": 7,
				"ContactGroupIdList": "572*",
				"Notice": {
					"EndTime": 1480607940000,
					"NoticeStartTime": 1480521600000,
					"StartTime": 1480521600000,
					"NoticeEndTime": 1480607940000
				},
				"UserId": "113197164949****",
				"AlertTitle": "TestAlertRule",
				"UpdateTime": 1594195623000,
				"AlertLevel": "WARN",
				"Id": 123,
				"RegionId": "cn-hangzhou",
				"AlertRule": {
					"Operator": "|",
					"Rules": [
						{
							"NValue": 5,
							"Operator": "CURRENT_GTE",
							"Aggregates": "AVG",
							"Alias": "调用响应时间_ms",
							"Measure": "appstat.transaction.rt",
							"Value": 2000
						},
						{
							"NValue": 5,
							"Operator": "CURRENT_GTE",
							"Aggregates": "AVG",
							"Alias": "调用错误次数",
							"Measure": "appstat.transaction.error",
							"Value": 1
						}
					]
				}
			}
		]
	},
	"RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3C****"
}