Get Alert Definition By Id Using GET

Using this method, you can look up details about a particular alert definition

Request

URI

GET

https://{api_host}/api/alertdefinitions/{id}

COPY

Path Parameters

string

Required

The id of the Alert Definition

Authentication

This operation uses the following authentication methods.

vRealizeOpsToken

Responses

200

The Alert Definition corresponding to the identifier specified

Returns alert-definition of type(s) application/json

{
    "adapterKindKey": "string",
    "cancelCycles": 0,
    "description": "string",
    "id": "string",
    "name": "string",
    "resourceKindKey": "string",
    "states": [
        {
            "impact": {
                "detail": "string",
                "impactType": "string"
            },
            "recommendationPriorityMap": {
                "recommendationPriorityMap": 0
            },
            "severity": "string",
            "symptoms": {}
        }
    ],
    "subType": 0,
    "type": 0,
    "waitCycles": 0
}

string

adapterKindKey

Required

The adapter kind key of the Adapter Kind that the Alert Definition applies to

integer As int32 As int32

cancelCycles

Optional

The Number of cycles the symptom conditions are false before ending the problem alert

string

description

Optional

The description of the problem definition

string

Optional

The unique identifier across the system. Must be null during create

string

name

Required

The Name of the Problem Definition

string

resourceKindKey

Required

The resource kind key for the Resource Kind that the Alert Definition applies to

array of alert-definition-state

states

Required

An Alert Definition state identifies the severity and impact a problem has when the set of Symptom Definition conditions are true. One Alert Definition state per severity.

integer As int32 As int32

subType

Optional

The sub type of the problem, for the purposes of routing an alert generated by this problem.

integer As int32 As int32

type

Optional

The type of the problem, for the purposes of routing an alert generated by this problem.

integer As int32 As int32

waitCycles

Optional

The Number of cycles the symptom conditions are true before triggering the problem alert