QueryEventsRequestType

QueryEventsRequestType
QueryEventsRequestType

The parameters of QueryEvents.

JSON Example
{
    "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
    },
    "eventViewSpec": {
        "_typeName": "string"
    }
}
filter
Required

Defines a filtering criteria for the event query.

eventViewSpec
Optional

Defines the view parameters for the event query.

To retrieve the newest events in the system, use 2147480000 (or the value of "config.vpxd.event.maxEventId" advanced vCenter configuration option) as EventManagerViewByStartId.startEventId and set EventManagerViewByStartId.isForward to false. To retrieve subsequent pages of results with older events, use the smallest event ID from the previous response as the EventManagerViewByStartId.startEventId and setEventManagerViewByStartId.isForward to false in the next query. To retrieve subsequent pages of results with newer events, use the biggest event ID from the previous page as the EventManagerViewByStartId.startEventId and set EventManagerViewByStartId.isForward to true in the next query.

Since: vSphere API Release 9.0.0.0

Parameter To