Vasa Provider Query Active Alarm

Query for the currently active alarms known to this VASA provider.

Provider is expected to return Red and Yellow types of alarms only. No Green alarms should be included in the result for this API.

Required privileges: StorageViews.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/sms/VasaProvider/{moId}/QueryActiveAlarm

COPY

Path Parameters

string

moId

Required

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

string

release

Required

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

Request Body

QueryActiveAlarmRequestType of type(s) application/json

Required

{
    "alarmFilter": {
        "_typeName": "string",
        "alarmStatus": "string",
        "alarmType": "string",
        "entityType": "string",
        "entityId": [
            {
                "_typeName": "string"
            }
        ],
        "pageMarker": "string"
    }
}

AlarmFilter

alarmFilter

Optional

This spec contains information needed for queryActiveAlarm API to filter the result.

This structure may be used only with operations rendered under /sms.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

AlarmResult containing all (or requested) active alarm objects owned by the VASA provider.

Returns AlarmResult of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "storageAlarm": [
        {
            "_typeName": "string",
            "alarmId": 0,
            "alarmType": "string",
            "containerId": "string",
            "objectId": "string",
            "objectType": "string",
            "status": "string",
            "alarmTimeStamp": "string",
            "messageId": "string",
            "parameterList": [
                {
                    "_typeName": "string",
                    "parameterName": "string",
                    "parameterValue": "string"
                }
            ],
            "alarmObject": {
                "_typeName": "string"
            }
        }
    ],
    "pageMarker": "string"
}

array of StorageAlarm

storageAlarm

Optional

Resulting storage alarms.

string

pageMarker

Optional

The page marker used for query pagination.

This is an opaque string that will be set by the VASA provider. The client will set the same value in AlarmFilter.pageMarker to query the next page. VP should unset this value to indicate the end of page.

500

InvalidArgument: if invalid input is provided.

NotImplemented: if the provider does not implement this function.

NotFound: if the specified entity does not exist.

ProviderBusy: if the provider is busy and cannot process the request.

InactiveProvider: if the provider is inactive for the specified entity.

ProviderUnavailable: if the provider is temporarily unavailable.

QueryExecutionFault: if an error is encountered while processing the query request.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

MethodFault

faultCause

Optional

The base data object type for all the object model faults that an application might handle.

array of LocalizableMessage

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

On This Page

Description

Request

Path Parameters