Event Manager Query Events

Returns the events in specified filter.

Returns empty array when there are not any events qualified.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/EventManager/{moId}/QueryEvents

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 EventManager/{moId}.

string

release

Required

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

Request Body

QueryEventsRequestType of type(s) application/json

Required

Show optional properties

{
    "filter": {}
}

{
    "filter": {
        "_typeName": "string",
        "entity": {
            "_typeName": "string",
            "entity": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "recursion": "string"
        },
        "time": {
            "_typeName": "string",
            "beginTime": "string",
            "endTime": "string"
        },
        "userName": {
            "_typeName": "string",
            "systemUser": false,
            "userList": [
                "string"
            ]
        },
        "eventChainId": 0,
        "alarm": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "scheduledTask": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "disableFullMessage": false,
        "category": [
            "string"
        ],
        "type": [
            "string"
        ],
        "tag": [
            "string"
        ],
        "eventTypeId": [
            "string"
        ],
        "maxCount": 0,
        "delayedInit": false
    }
}

EventFilterSpec

filter

Required

Event filter used to query events in the history collector database.

The client creates an event history collector with a filter specification, then retrieves the events from the event history collector.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The events matching the filter.

Returns Array of Event of type(s) application/json

[
    {
        "_typeName": "string",
        "key": 0,
        "chainId": 0,
        "createdTime": "string",
        "userName": "string",
        "datacenter": {
            "_typeName": "string",
            "name": "string",
            "datacenter": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        },
        "computeResource": {
            "_typeName": "string",
            "name": "string",
            "computeResource": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        },
        "host": {
            "_typeName": "string",
            "name": "string",
            "host": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        },
        "vm": {
            "_typeName": "string",
            "name": "string",
            "vm": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        },
        "ds": {
            "_typeName": "string",
            "name": "string",
            "datastore": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        },
        "net": {
            "_typeName": "string",
            "name": "string",
            "network": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        },
        "dvs": {
            "_typeName": "string",
            "name": "string",
            "dvs": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        },
        "fullFormattedMessage": "string",
        "changeTag": "string"
    }
]

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations

POST

Event Manager Create Collector For Events

GET