Property Collector Cancel Retrieve Properties Ex

Discards remaining results from a retrieval started by RetrievePropertiesEx on the same session on the same PropertyCollector.

Required privileges: System.Read

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/PropertyCollector/{moId}/CancelRetrievePropertiesEx

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

string

release

Required

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

Request Body

CancelRetrievePropertiesExRequestType of type(s) application/json

Required

{
    "token": "string"
}

string

token

Required

the token returned in the previous RetrieveResult returned on the same session by the same PropertyCollector.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidArgument: If the token does not match the token from the previous RetrieveResult returned on the same session by the same PropertyCollector.

Returns InvalidProperty of type(s) application/json

This response body class contains all of the following: MethodFault

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

string

name

Required

The property name that generated the error.

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body