[{"label":"Latest (2022-10-31)","version":"latest"}]
vrealize-operations
Query Alert Groups
Description Example: POST /api/alerts/group/{groupingCondition}/query
Request
URLURL
https://localhost/suite-api/api/alerts/group/{groupingCondition}/query
Path Parameters
Path Parameters
string
groupingCondition
Required
The condition to be used for grouping
Query Parameters
Query Parameters
string
adapterKind
Optional
Adapter kind to be used for grouping alerts by SCOPE
integer
page
Optional
Page number from which data needs to be displayed (0-based)
integer
pageSize
Optional
Expected number of entries per page
string
resourceKind
Optional
Resource kind to be used for grouping alerts by SCOPE
string
resourceNameFilter
Optional
Filter based on alert resource name (Used only in SCOPE flow)
Request Body
Request Body
alert-query
of type(s) application/json, application/xml
Required
The alertQuery criteria
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
AlertGroups
of type(s) application/json, application/xml
AlertGroups of alerts matching the specified Query Spec and grouped using specified grouping-condition(Collection can be empty)
Errors
500
Error occurred while retrieving the AlertGroups
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"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"}' https://localhost/suite-api/api/alerts/group/{groupingCondition}/query
[{"label":"Latest (2022-10-31)","version":"latest"}]
vrealize-operations
On This Page
Alerts Operations
post
delete
delete
delete
get
get
get
get
get
post
post
post
post
