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

SymptomQuery

Query for Symptoms using various criteria. Composition of filtering criteria controlled via the compositeOperator property. Pagination of the Symptoms that are returned can be controlled via the PageInfo object. Sorting of the Symptoms is specified via the SymptomField object and the SortOrder object controls the order in which the Symptoms are sorted. If a sort field is not specified but pagination is requested the Symptoms will be sorted by the alarmId property.


Properties

boolean
activeOnly Optional

Include Symptoms that are currently Active. By default, only active Symptoms are included in the result


array of string
alarmCriticality Optional

Return Symptoms that have the specified list of Symptom Criticalities

Possible values are: UNKNOWNNONEINFORMATIONWARNINGIMMEDIATECRITICALAUTO


array of integer as int32
alarmType Optional

Return Symptoms that have the specified list of Symptom Types


cancelTimeRange Optional

Return Symptoms that have the specified 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) NOTE: OR is currently not supported.

Possible values are: ANDOR


boolean
includeAlarmInfo Optional

Boolean that controls the retrieval of alarm information of the symptom


boolean
includeChildrenResources Optional

Whether to include Symptoms of all the children of resources identified by resourceIds


resource-query Optional

Return alarms associated with resources matching query criteria


startTimeRange Optional

Return Symptoms that have the specified start time


array of string
statKey Optional

Return Symptoms that have been generated because of violations on the Stat Keys specified


array of string
symptomDefinitionId Optional

Return Symptoms that have the specified list of Symptom Definitions


array of string as uuid
symptomId Optional

Return Symptoms that have the specified list of Symptom identifiers

JSON Example

{
	"activeOnly": false,
	"alarmCriticality": [
		"UNKNOWN"
	],
	"alarmType": [
		0
	],
	"cancelTimeRange": {
		"endTime": 0,
		"startTime": 0
	},
	"compositeOperator": "AND",
	"includeAlarmInfo": false,
	"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
	},
	"startTimeRange": {
		"endTime": 0,
		"startTime": 0
	},
	"statKey": [
		"string"
	],
	"symptomDefinitionId": [
		"string"
	],
	"symptomId": [
		"string"
	]
}
[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations
Parameter To

Query Symptoms