Task History Collector Read Previous Tasks

Reads the 'scrollable view' from the current position.

The scrollable position is then moved to the next older page after the read. No item is returned when the head of the collector is reached.

Request

URI

POST

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

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

string

release

Required

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

Request Body

ReadPreviousTasksRequestType of type(s) application/json

Required

{
    "maxCount": 0
}

integer As int32 As int32

maxCount

Required

The maximum number of items in the page.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

[
    {
        "_typeName": "string",
        "key": "string",
        "task": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "description": {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        },
        "name": "string",
        "descriptionId": "string",
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "entityName": "string",
        "locked": [
            {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "state": "string",
        "cancelled": false,
        "cancelable": false,
        "error": {
            "_typeName": "string",
            "faultCause": {
                "_typeName": "string",
                "faultCause": "MethodFault Object",
                "faultMessage": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "arg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ],
                        "message": "string"
                    }
                ]
            },
            "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"
    }
]

array of object

Optional

This data object type contains all information about a task.

A task represents an operation performed by VirtualCenter or ESX.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"maxCount":"integer"}' https://{api_host}/sdk/vim25/{release}/TaskHistoryCollector/{moId}/ReadPreviousTasks

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations

POST

Task History Collector Read Next Tasks

POST