SearchAlertRules

Request parameters

Response parameters

Alert metrics

• Alert type (metricParam.type): TXN
  • Dimension (dimensions.key): rpc
  • Metrics (alertRule.rules.measure):
    • appstat.txn.rt: the response time of API calls in milliseconds
    • appstat.txn.count: the number of API calls
    • appstat.txn.errcount: the number of API call errors
• Alert type (metricParam.type): TXN_TYPE
  • Dimension (dimensions.key): rpcType
  • Metrics (alertRule.rules.measure):
    • appstat.inbound.rt: the response time of API calls for the services that are provided by the application, in milliseconds
    • appstat.inbound.count: the number of API calls for the services that are provided by the application
    • appstat.inbound.error: the number of API call errors for the services that are provided by the application
    • appstat.outbound.rt: the response time of API calls for the services on which the application depends, in milliseconds
    • appstat.outbound.count: the number of API calls for the services on which the application depends
    • appstat.outbound.error: the number of API call errors for the services on which the application depends
• Alert type (metricParam.type): DB
  • Dimension (dimensions.key): endpoint
  • Metrics (alertRule.rules.measure):
    • appstat.database.rt: the response time of API calls for the database
    • appstat.database.count: the number of API calls for the database
    • appstat.database.errcount: the number of API call errors for the database
• Alert type (metricParam.type): JVM
  • Dimension (dimensions.key): rootIp
  • Metrics (alertRule.rules.measure):
    • appstat.jvm.heap_used: the total memory in the JVM heap, in bytes
    • appstat.jvm.GcPsScavengeCount: the number of garbage collection (GC) in JVM
    • appstat.jvm.GcPsMarkSweepCount: the number of tag deletions in JVM
    • appstat.jvm.GcG1OldGenCount: the number of G1GC in JVM_Old
    • appstat.jvm.GcG1YoungGenCount: the number of G1GC in JVM_Young
    • appstat.jvm.gc.YoungGcCountInstant: the number of GC in JVM_Young
    • appstat.jvm.gc.OldGcCountInstant: the number of GC in JVM_Full
    • appstat.jvm.gc.YoungGcTimeInstant: the time that takes for the JVM_Young GC, in milliseconds
    • appstat.jvm.gc.OldGcTimeInstant: the time that takes for the JVM_Full GC, in milliseconds
    • appstat.jvm.ThreadCount: the total number of JVM threads
    • appstat.jvm.non_heap_used: the used space of the non-heap JVM memory, in bytes
    • appstat.jvm.non_heap_max: the total space of the non-heap JVM memory, in bytes
    • appstat.jvm.non_heap_init: the initial space of the non-heap JVM memory, in bytes
    • appstat.jvm.non_heap_committed: the submitted space of the non-heap JVM memory, in bytes
• Alert type (metricParam.type): HOST
  • Dimension (dimensions.key): rootIp
  • Metrics (alertRule.rules.measure):
    • appstat.jvm.SystemCpuUser: the used CPU of the machine, in percentage
    • appstat.jvm.SystemMemFree: the idle memory of the machine, in bytes
    • appstat.jvm.SystemDiskFree: the idle disk space of the machine, in bytes
    • appstat.jvm.SystemNetInErrs: the number of error messages that is received by the machine
    • appstat.jvm.SystemNetOutErrs: the number of error messages that is sent by the machine
    • appstat.jvm.SystemLoad: the system load of the machine
• Alert type (metricParam.type): EXCEPTION
  • Dimension (dimensions.key): rpc
  • Metrics (alertRule.rules.measure):
    • appstat.exception.rt: the response time of abnormal API calls for the application, in milliseconds
    • appstat.exception.count: the number of abnormal API calls

Examples

Sample requests

http(s)://[Endpoint]/? Action=SearchAlertRules
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<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>Alert name: $alert name\nFiltering condition: $filter\n Alert time: $alert time\nAlert content: $alert content\nNote: The alert is continuously triggered until a reply email is received. The system will remind you 24 hours later. </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>response time_ms</Alias>
					          <Measure>appstat.transaction.rt</Measure>
					          <Value>2000</Value>
				        </Rules>
				        <Rules>
					          <NValue>5</NValue>
					          <Operator>CURRENT_GTE</Operator>
					          <Aggregates>AVG</Aggregates>
					          <Alias>the number of API call errors</Alias>
					          <Measure>appstat.transaction.error</Measure>
					          <Value>1</Value>
				        </Rules>
			      </AlertRule>
		    </AlertRules>
	  </PageBean>
	  <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3C****</RequestId>
</SearchAlertRulesResponse>

JSON format

{
	"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": "Alert name: $alert name\nFiltering condition: $filter\n Alert time: $alert time\nAlert content: $alert content\nNote: The alert is continuously triggered until a reply email is received. The system will remind you 24 hours later.",
					"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": "response time_ms",
							"Measure": "appstat.transaction.rt",
							"Value": 2000
						},
						{
							"NValue": 5,
							"Operator": "CURRENT_GTE",
							"Aggregates": "AVG",
							"Alias": "the number of API call errors",
							"Measure": "appstat.transaction.error",
							"Value": 1
						}
					]
				}
			}
		]
	},
	"RequestId": "34ED024E-9E31-434A-9E4E-D9D15C3C****"
}