Vsan Performance Manager Vsan Perf Create Stats Object Task

The asynchronous API of CreateStatsObject.

The stats obj is created in in background, with a task returned. This method is only supported on vCenter.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfCreateStatsObjectTask

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

string

release

Required

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

Request Body

VsanPerfCreateStatsObjectTaskRequestType of type(s) application/json

Optional

{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "profile": {
        "_typeName": "string"
    }
}

cluster

Optional

vSAN cluster. Ignored if called against host.

Required privileges: Host.Inventory.EditCluster

profile

Optional

Profile to be used for the stats object, see above

Authentication

This operation uses the following authentication methods.

Session

Responses

200

vim task

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

VsanFault: if the caller doesn't have the required privilege, or the cluster has no hosts.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_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"
        }
    ]
}

faultCause

Optional

Fault which is the cause of this fault.

array of object

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfCreateStatsObjectTask

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan Performance Manager Vsan Perf Create Stats Object