Get Alert Instances

Get Alert Instances

Gets all alert instances. You can view the alerts that have been triggered in the last hour, day, or week. You can also view details for the last 100 alerts triggered

Request
URI
POST
https://{api_host}//vrlic/api/v1/alert/instances/query
COPY
Request Body
AlertInstanceQueryState of type(s) application/json
Required 
{
    "startTime": 1688978873485,
    "endTime": 1688979173485,
    "metadataKey": "key",
    "metadataValue": "value",
    "namespace": "com.vmware.li",
    "alertConfigurationLink": "7d4de7e7-72b4-4093-adfd-6f68e4096490",
    "resultLimit": 500,
    "alertInstanceColl": [
        {
            "selfLink": "/vrlic/api/v1/alert/instances/2c45f884-6c34-445d-9e32-a4a21ed04f90",
            "alertDefinitionLink": "/vrlic/api/v1/alert/1a01aba9-7b1a-4fa2-92dd-2b3512682ek9",
            "alertTriggerTimeMillis": 1688979004675,
            "alertName": "test_alert",
            "alertDescription": "test_alert description",
            "alertConfigurationLink": "7d4de7e7-72b4-4093-adfd-6f68e4096490",
            "namespace": "com.vmware.li",
            "metadata": {
                "messages": [
                    "alert instance test message"
                ],
                "logs": [
                    {
                        "environment": "stg",
                        "event_type": "t1_c7hj4b"
                    }
                ]
            },
            "alertType": "COUNT",
            "alertSeverity": "WARNING",
            "tags": [
                "test-Prediction"
            ],
            "tagIds": [
                "c6620251-4462-47b1-ab93-18690504e289"
            ],
            "logRcaInvestigationId": "ef6ff0251-4462-47b1-ab93-18690504e289"
        }
    ],
    "alertGroupColl": [
        {
            "count(*)": "1",
            "alertseverity": "IMMEDIATE",
            "timestamp": "2023-07-10T08:52:38.729Z"
        }
    ],
    "nextPageLink": "/vrlic/api/v1/query/9b4a1dd5-3e09-4a59-9e00-a8f319b4061a",
    "alertType": "COUNT",
    "queryCriteria": {
        "constraints": {
            "constraints": [
                {
                    "constraints": [
                        {
                            "constraints": [],
                            "fieldName": "text",
                            "operator": "CONTAINS",
                            "tags": [],
                            "value": "ankita"
                        }
                    ],
                    "fieldName": null,
                    "operator": "AND",
                    "tags": [
                        "log-intelligence:search-bar"
                    ],
                    "value": null
                },
                {
                    "constraints": [
                        {
                            "constraints": [],
                            "fieldName": "text",
                            "operator": "CONTAINS",
                            "tags": [],
                            "value": "error"
                        }
                    ],
                    "fieldName": null,
                    "operator": "AND",
                    "tags": [],
                    "value": null
                }
            ],
            "fieldName": null,
            "operator": "AND",
            "tags": [],
            "value": null
        },
        "contentPackId": "9e21284e-c1d8-43f8-b95f-2ebaea801389",
        "description": "Query Logs based on contraints",
        "groupByTerms": [
            {
                "fieldName": "timestamp",
                "groupByType": "FIXED_BUCKET"
            },
            {
                "fieldName": "alertSeverity",
                "groupByType": "EACH_VALUE"
            }
        ]
    }
}
integer As int64 As int64
startTime
Required

Returns alert instances that were created/updated after this time in milliseconds

integer As int64 As int64
endTime
Required

Returns alert instances that were created/updated before this time in milliseconds

string
metadataKey
Optional

Metadata key associated with the alert instance query state

string
metadataValue
Optional

Metadata value associated with the alert instance query state

string
namespace
Required

Namespace of the alert instance query state, e.g., com.vmware.li

string
alertConfigurationLink
Optional

Configuration link associated with the alert instance query state

array of string
tenantLinks
Optional

Set of tenant links

integer As int32 As int32
resultLimit
Required

Maximum number of results to be returned per page.

array of AlertInstance
alertInstanceColl
Optional

Collection of alert instances.

array of object
alertGroupColl
Optional

Collection of alert histogram instances.

string
nextPageLink
Optional

It refers to the log query API that retrieves activated alert instances within a customizable time frame, like the past 1 hour or 15 minutes.

string
alertType
Optional

Type of alert

AlertQueryCriteria
queryCriteria
Optional

queryCriteria

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AlertInstanceQueryState of type(s) */* 
{
    "startTime": 1688978873485,
    "endTime": 1688979173485,
    "metadataKey": "key",
    "metadataValue": "value",
    "namespace": "com.vmware.li",
    "alertConfigurationLink": "7d4de7e7-72b4-4093-adfd-6f68e4096490",
    "resultLimit": 500,
    "alertInstanceColl": [
        {
            "selfLink": "/vrlic/api/v1/alert/instances/2c45f884-6c34-445d-9e32-a4a21ed04f90",
            "alertDefinitionLink": "/vrlic/api/v1/alert/1a01aba9-7b1a-4fa2-92dd-2b3512682ek9",
            "alertTriggerTimeMillis": 1688979004675,
            "alertName": "test_alert",
            "alertDescription": "test_alert description",
            "alertConfigurationLink": "7d4de7e7-72b4-4093-adfd-6f68e4096490",
            "namespace": "com.vmware.li",
            "metadata": {
                "messages": [
                    "alert instance test message"
                ],
                "logs": [
                    {
                        "environment": "stg",
                        "event_type": "t1_c7hj4b"
                    }
                ]
            },
            "alertType": "COUNT",
            "alertSeverity": "WARNING",
            "tags": [
                "test-Prediction"
            ],
            "tagIds": [
                "c6620251-4462-47b1-ab93-18690504e289"
            ],
            "logRcaInvestigationId": "ef6ff0251-4462-47b1-ab93-18690504e289"
        }
    ],
    "alertGroupColl": [
        {
            "count(*)": "1",
            "alertseverity": "IMMEDIATE",
            "timestamp": "2023-07-10T08:52:38.729Z"
        }
    ],
    "nextPageLink": "/vrlic/api/v1/query/9b4a1dd5-3e09-4a59-9e00-a8f319b4061a",
    "alertType": "COUNT",
    "queryCriteria": {
        "constraints": {
            "constraints": [
                {
                    "constraints": [
                        {
                            "constraints": [],
                            "fieldName": "text",
                            "operator": "CONTAINS",
                            "tags": [],
                            "value": "ankita"
                        }
                    ],
                    "fieldName": null,
                    "operator": "AND",
                    "tags": [
                        "log-intelligence:search-bar"
                    ],
                    "value": null
                },
                {
                    "constraints": [
                        {
                            "constraints": [],
                            "fieldName": "text",
                            "operator": "CONTAINS",
                            "tags": [],
                            "value": "error"
                        }
                    ],
                    "fieldName": null,
                    "operator": "AND",
                    "tags": [],
                    "value": null
                }
            ],
            "fieldName": null,
            "operator": "AND",
            "tags": [],
            "value": null
        },
        "contentPackId": "9e21284e-c1d8-43f8-b95f-2ebaea801389",
        "description": "Query Logs based on contraints",
        "groupByTerms": [
            {
                "fieldName": "timestamp",
                "groupByType": "FIXED_BUCKET"
            },
            {
                "fieldName": "alertSeverity",
                "groupByType": "EACH_VALUE"
            }
        ]
    }
}
integer As int64 As int64
startTime
Required

Returns alert instances that were created/updated after this time in milliseconds

integer As int64 As int64
endTime
Required

Returns alert instances that were created/updated before this time in milliseconds

string
metadataKey
Optional

Metadata key associated with the alert instance query state

string
metadataValue
Optional

Metadata value associated with the alert instance query state

string
namespace
Required

Namespace of the alert instance query state, e.g., com.vmware.li

string
alertConfigurationLink
Optional

Configuration link associated with the alert instance query state

array of string
tenantLinks
Optional

Set of tenant links

integer As int32 As int32
resultLimit
Required

Maximum number of results to be returned per page.

array of AlertInstance
alertInstanceColl
Optional

Collection of alert instances.

array of object
alertGroupColl
Optional

Collection of alert histogram instances.

string
nextPageLink
Optional

It refers to the log query API that retrieves activated alert instances within a customizable time frame, like the past 1 hour or 15 minutes.

string
alertType
Optional

Type of alert

AlertQueryCriteria
queryCriteria
Optional

queryCriteria


On This Page
Alerts And Notifications Operations
POST
Create Alert
POST
Create Webhook Payload Parameter
DELETE
Delete Alert
GET
Get Alert
GET
Get Alert Instance
POST
Get Alert Instances
GET
Get Alerts
PATCH
Patch Alert
PUT
Update Alert