Compute Resource Get Declared Alarm State

A set of alarm states for alarms that apply to this managed entity.

The set includes alarms defined on this entity and alarms inherited from the parent entity, or from any ancestors in the inventory hierarchy.

Alarms are inherited if they can be triggered by this entity or its descendants. This set does not include alarms that are defined on descendants of this entity.

Required privileges: System.View

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/ComputeResource/{moId}/declaredAlarmState

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 ComputeResource/{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 Array of AlarmState of type(s) application/json

[
    {
        "_typeName": "string",
        "key": "string",
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "alarm": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "overallStatus": "string",
        "time": "string",
        "acknowledged": false,
        "acknowledgedByUser": "string",
        "acknowledgedTime": "string",
        "eventKey": 0,
        "disabled": false
    }
]

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Virtual Infrastructure Operations