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

Query Alert

Description

Data returned includes a Collection of Alert Notes. Example: POST /api/alerts/query

Request

Request

URL

URL


post
https://localhost/suite-api/api/alerts/query
Copy

Query Parameters

Query Parameters

integer
page Optional

Page number from which data needs to be displayed (0-based)


integer
pageSize Optional

Expected number of entries per page


Request Body

Request Body

alert-query of type(s) application/json, application/xml Required

The alertQuery criteria

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns Alerts of type(s) application/json, application/xml

The Collection of Alerts matching the specified Query Spec (Collection can be empty)

Errors

Errors

500

Error occurred while retrieving the Alerts

Code Samples

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/query


Feedback

Was this page helpful?