[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations

AlertQuery

Query for alerts by various criteria. Composition of filtering criteria controlled via the compositeOperator property. For Pagination see PageInfo For sorting see AlertField and SortOrder enumerations. If a sort field is not specified but pagination is requested the Alerts will be sorted by the alertId field.


Properties

boolean
activeOnly Optional

Filter to return only Active alerts, if true, the query will exclude Suspended and Cancelled Alerts


array of string
alertControlState Optional

Filter based on the Alert Control State

Possible values are: OPENASSIGNEDSUSPENDEDSUPPRESSED


array of string
alertCriticality Optional

Filter based on Alert Criticality

Possible values are: UNKNOWNNONEINFORMATIONWARNINGIMMEDIATECRITICALAUTO


array of string
alertDefinitionId Optional

Filter based on the Alert definition id


array of string as uuid
alertId Optional

Filter based on Alert identifiers


array of string
alertImpact Optional

Filter based on the Alert Impact


string
alertName Optional

Filter based on Alert name using ‘contains’ logic


array of string
alertStatus Optional

Filter based on the Alert Status. If looking for only active alerts combined with other filter criteria then use the activeOnly property instead.

Possible values are: NEWACTIVEUPDATEDCANCELED


array of AlertTypeMapping
alertTypeSubtype Optional

Filter based on Alert Type


cancelTimeRange Optional

Filter based on matching UTC cancel time


string
compositeOperator Optional

Indicates the composition of the filtering criteria. Either all of the filtering criteria apply together (AND operation) or any of the filtering criteria could be applied (OR operation) Defaults to AND. Note: backend only supports AND currently

Possible values are: ANDOR


boolean
extractOwnerName Optional

Indicates whether need to report alert owner’s name in addition to owner’s id


string
groupId Optional

Filter based on alert group id


string
groupingCondition Optional

Condition that should be used for grouping

Possible values are: GROUP_BY_ALERT_DEFINITIONGROUP_BY_RESOURCE_KINDGROUP_BY_CRITICALITYGROUP_BY_TIMEGROUP_BY_SCOPE


boolean
includeChildrenResources Optional

True to include alerts generated by child resources


resource-query Optional

Return alarms associated with resources matching query criteria


string
resourceKind Optional

Filter based on resource kind using ‘contains’ logic


startTimeRange Optional

Filter based on matching UTC start time


updateTimeRange Optional

Filter based on matching UTC update time


string
userId Optional

Filter based on user id


string
userName Optional

Filter based on user name using ‘contains’ logic

JSON Example

{
	"activeOnly": false,
	"alertControlState": [
		"OPEN"
	],
	"alertCriticality": [
		"UNKNOWN"
	],
	"alertDefinitionId": [
		"string"
	],
	"alertId": [
		"string"
	],
	"alertImpact": [
		"string"
	],
	"alertName": "string",
	"alertStatus": [
		"NEW"
	],
	"alertTypeSubtype": [
		{
			"subtypeIds": [
				0
			],
			"typeId": 0
		}
	],
	"cancelTimeRange": {
		"endTime": 0,
		"startTime": 0
	},
	"compositeOperator": "AND",
	"extractOwnerName": false,
	"groupId": "string",
	"groupingCondition": "GROUP_BY_ALERT_DEFINITION",
	"includeChildrenResources": false,
	"resource-query": {
		"adapterInstanceId": [
			"string"
		],
		"adapterKind": [
			"string"
		],
		"collectorId": [
			0
		],
		"collectorName": [
			"string"
		],
		"credentialId": [
			"string"
		],
		"includeRelated": "PARENT",
		"maintenanceScheduleId": [
			"string"
		],
		"name": [
			"string"
		],
		"parentId": [
			"string"
		],
		"propertyConditions": {
			"conditions": [
				{
					"doubleValue": 0,
					"key": "string",
					"operator": "EQ",
					"stringValue": "string"
				}
			],
			"conjunctionOperator": "AND"
		},
		"propertyName": "string",
		"propertyValue": "string",
		"recentlyAdded": 0,
		"regex": [
			"string"
		],
		"resourceHealth": [
			"GREEN"
		],
		"resourceId": [
			"string"
		],
		"resourceKind": [
			"string"
		],
		"resourceState": [
			"STOPPED"
		],
		"resourceStatus": [
			"NONE"
		],
		"resourceTag": [
			{
				"category": "string",
				"name": "string"
			}
		],
		"statConditions": {
			"conditions": [
				{
					"doubleValue": 0,
					"key": "string",
					"operator": "EQ",
					"stringValue": "string"
				}
			],
			"conjunctionOperator": "AND"
		},
		"statKey": "string",
		"statKeyInclusive": false,
		"statKeyLowerBound": 0,
		"statKeyUpperBound": 0
	},
	"resourceKind": "string",
	"startTimeRange": {
		"endTime": 0,
		"startTime": 0
	},
	"updateTimeRange": {
		"endTime": 0,
		"startTime": 0
	},
	"userId": "string",
	"userName": "string"
}
[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations
Property Of

AlertNotesQuery
Parameter To

Delete Canceled Alerts
Query Alert Groups
Query Alert

Feedback

Was this page helpful?