Vsan Io Insight Manager Delete Io Insight Instance

Delete information of a completed ioinsight instance specified by the passed-in runName.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanIoInsightManager/{moId}/DeleteIoInsightInstance

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

string

release

Required

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

Request Body

DeleteIoInsightInstanceRequestType of type(s) application/json

Required

Show optional properties

{
    "runName": "string"
}

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

string

runName

Required

Run name of the ioinsight instance.

cluster

Optional

The target cluster where the ioinsight instance belongs to. This parameter is ignored while the API is called against host.

Required privileges: Global.Diagnostics

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidArgument: If any argument passed to the function is not specified correctly.

NotFound: If the specified ioinsight instance is not found.

NotSupported: If the API is not supported by the called host.

VsanFault: If any other unexpected fault is encountered.

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 '{"runName":"string"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanIoInsightManager/{moId}/DeleteIoInsightInstance

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

V San Service Api Operations

POST

Vsan Io Insight Manager Delete Io Insight Instance