Vsan Performance Manager Get Vsan Perf Diagnosis Result

Returns the diagnosis result from the in memory cache for the supplied task.

The task should have been returned by VsanPerfDiagnoseTask. This API is available only in the vCenter, it is not available at the end-host.

Request

URI

POST

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

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

GetVsanPerfDiagnosisResultRequestType of type(s) application/json

Required

Show optional properties

{
    "task": {}
}

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

task

Required

Task returned by VsanPerfDiagnoseTask

cluster

Optional

vSAN cluster. Ignored if called against host.

Required privileges: Global.Diagnostics

Authentication

This operation uses the following authentication methods.

Session

Responses

200

A list of performance issues.

[
    {
        "_typeName": "string",
        "exceptionId": "string",
        "recommendation": "string",
        "aggregationFunction": "string",
        "aggregationData": {
            "_typeName": "string",
            "entityRefId": "string",
            "sampleInfo": "string",
            "value": [
                {
                    "_typeName": "string",
                    "metricId": {
                        "_typeName": "string",
                        "label": "string",
                        "group": "string",
                        "rollupType": "string",
                        "statsType": "string",
                        "name": "string",
                        "description": "string",
                        "metricsCollectInterval": 0
                    },
                    "threshold": {
                        "_typeName": "string",
                        "direction": "string",
                        "yellow": "string",
                        "red": "string"
                    },
                    "numExceptions": "string",
                    "values": "string"
                }
            ]
        },
        "exceptionData": [
            {
                "_typeName": "string",
                "entityRefId": "string",
                "sampleInfo": "string",
                "value": [
                    {
                        "_typeName": "string",
                        "metricId": {
                            "_typeName": "string",
                            "label": "string",
                            "group": "string",
                            "rollupType": "string",
                            "statsType": "string",
                            "name": "string",
                            "description": "string",
                            "metricsCollectInterval": 0
                        },
                        "threshold": {
                            "_typeName": "string",
                            "direction": "string",
                            "yellow": "string",
                            "red": "string"
                        },
                        "numExceptions": "string",
                        "values": "string"
                    }
                ]
            }
        ]
    }
]

array of object

Optional

This data object type stores a performance diagnostic exception, relevant performance data, with a goal to help root cause a performance issue in a vSAN cluster.

A performance diagnostic exception points to a possible reason due to which the vSAN cluster may be seeing poorer performance during the queried time interval. We raise an independent performance diagnostic exception for each issue that we find, and do _not_ group similar types of performance exceptions currently. It is left to the user (such as the UI), to do the grouping.

This structure may be used only with operations rendered under /vsan.

500

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

NotFound: If no result is found in the cache for the specified task

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

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

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations