Alarm Get Info | Virtual Infrastructure JSON API

Alarm Get Info

Information about this alarm.

Required privileges: System.View

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/Alarm/{moId}/info

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case Alarm/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns AlarmInfo of type(s) application/json

This response body class contains all of the following: AlarmSpec

{
    "_typeName": "string",
    "name": "string",
    "systemName": "string",
    "description": "string",
    "enabled": false,
    "expression": {
        "_typeName": "string"
    },
    "action": {
        "_typeName": "string"
    },
    "actionFrequency": 0,
    "setting": {
        "_typeName": "string",
        "toleranceRange": 0,
        "reportingFrequency": 0
    },
    "key": "string",
    "alarm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "lastModifiedTime": "string",
    "lastModifiedUser": "string",
    "creationEventId": 0
}

string

key

Required

The unique key.

MoRefAlarm

alarm

Required

Reference to an instance of the Alarm managed object.

MoRefManagedEntity

entity

Required

Reference to an instance of the ManagedEntity managed object.