Get Alert Instance | VMware Services - VMware Aria Operations for Logs

Get Alert Instance

Gets an alert instance

Request

URI

GET

https://{api_host}//vrlic/api/v1/alert/instances/{id}

COPY

Path Parameters

string

Required

Alert Id

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns AlertInstance of type(s) */*

{
    "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"
}

string

selfLink

Optional

Self link associated with the alert instance

string

alertDefinitionLink

Optional

Reference to the alert definition

integer As int64 As int64

alertTriggerTimeMillis

Optional

Time when the alert was triggered (in milliseconds)

string

alertName

Optional

Short name describing the alert definition

string

alertDescription

Optional

Long description of the alert definition

string

alertConfigurationLink

Optional

Reference to the alert configuration that triggered the alert

array of string

tenantLinks

Optional

Set of tenant links associated with the alert instance

string

namespace

Optional

Namespace associated with the alert instance

object

metadata

Optional

Map of the metadata associated with the alert instance

string

alertType

Optional

Alert type associated with the alert instance, which includes: per-event, windowed

string

alertSeverity

Optional

Alert severity, which includes: CRITICAL, IMMEDIATE, WARNING, INFO

array of string