Task History Collector Get Latest Page

The items in the 'viewable latest page'.

As new tasks that match the collector's TaskFilterSpec are created, they are added to this page, and the oldest tasks are removed from the collector to keep the size of the page to that allowed by SetCollectorPageSize.

The "oldest task" is the one with the oldest creation time. The tasks in the returned page are unordered.

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/TaskHistoryCollector/{moId}/latestPage

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

string

release

Required

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

Authentication

This operation uses the following authentication methods.

Session

Responses

200

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

[
    {
        "_typeName": "string",
        "key": "string",
        "task": {
            "type": "string",
            "value": "string"
        },
        "description": {
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        },
        "name": "string",
        "descriptionId": "string",
        "entity": {
            "type": "string",
            "value": "string"
        },
        "entityName": "string",
        "locked": [
            {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "state": "string",
        "cancelled": false,
        "cancelable": false,
        "error": {
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        },
        "result": {
            "_typeName": "string"
        },
        "progress": 0,
        "progressDetails": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ],
        "reason": {
            "_typeName": "string"
        },
        "queueTime": "string",
        "startTime": "string",
        "completeTime": "string",
        "eventChainId": 0,
        "changeTag": "string",
        "parentTaskKey": "string",
        "rootTaskKey": "string",
        "activationId": "string"
    }
]

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Task History Collector Operations

POST

Task History Collector Destroy Collector

GET

Task History Collector Get Filter