Vsan Performance Manager Vsan Perf Diagnose

Vsan Performance Manager Vsan Perf Diagnose
API to do performance diagnosis.

Deprecated as of vSphere API 6.7, please use VsanPerfDiagnoseTask instead.

API to do performance diagnosis.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfDiagnose
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
VsanPerfDiagnoseRequestType of type(s) application/json
Required

Show optional properties

{
    "perfDiagnoseQuery": {}
}
{
    "perfDiagnoseQuery": {
        "_typeName": "string",
        "startTime": "string",
        "endTime": "string",
        "queryType": "string",
        "context": "string"
    },
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
perfDiagnoseQuery
Required

The query describing details of diagnosis required, such as the period of diagnosis and the query type.

cluster
Optional

vSAN cluster. Ignored if called against host.

Required privileges: System.Read

Authentication
This operation uses the following authentication methods.
Responses
200

The list of performance issues found. Each performance issue is returned as a VsanPerfDiagnosticResult. The VsanPerfDiagnosticResult object will contain the entity and the metrics that caused the performance exception.

[
    {
        "_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

Failure

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 '{"perfDiagnoseQuery":"{}"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfDiagnose
Deprecated
On This Page
V San Service Api Operations
POST
Vsan Performance Manager Vsan Perf Create Stats Object
POST
Vsan Performance Manager Vsan Perf Create Stats Object Task
POST
Vsan Performance Manager Vsan Perf Delete Stats Object
POST
Vsan Performance Manager Vsan Perf Delete Stats Object Task
POST
Vsan Performance Manager Vsan Perf Delete Time Range
POST
Vsan Performance Manager Vsan Perf Get Aggregated Entity Types
POST
Vsan Performance Manager Vsan Perf Get Supported Diagnostic Exceptions
POST
Vsan Performance Manager Vsan Perf Get Supported Entity Types
POST
Vsan Performance Manager Vsan Perf Get Supported Hotspot Entity Types
POST
Vsan Performance Manager Get Vsan Perf Diagnosis Result
POST
Vsan Performance Manager Vsan Perf Query Cluster Health
POST
Vsan Performance Manager Vsan Perf Query Node Information
POST
Vsan Performance Manager Query Remote Server Clusters
POST
Vsan Performance Manager Vsan Perf Query Stats Object Information
POST
Vsan Performance Manager Vsan Perf Query Time Ranges
POST
Vsan Performance Manager Vsan Perf Query Perf
POST
Vsan Performance Manager Query Vsan Perf Hotspot Entities
POST
Vsan Performance Manager Query Vsan Perf Top Entities
POST
Vsan Performance Manager Vsan Perf Save Time Ranges
POST
Vsan Performance Manager Vsan Perf Set Stats Object Policy
POST
Vsan Performance Manager Vsan Perf Toggle Verbose Mode
POST
Vsan Performance Manager Vsan Perf Diagnose
Deprecated
POST
Vsan Performance Manager Vsan Perf Diagnose Task