Vsan File Service System Vsan Cluster Query Share Snapshots

List all the snapshots that match the query spec.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanClusterQueryShareSnapshots

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

string

release

Required

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

Request Body

VsanClusterQueryShareSnapshotsRequestType of type(s) application/json

Required

"VsanClusterQueryShareSnapshotsRequestType Object"

querySpec

Required

The specification of the snapshots to be queried.

cluster

Optional

The target cluster. Ignored when called on ESXi hosts.

Required privileges: System.Read

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Result of the snapshot query.

This response body class contains all of the following: VsanFileShareSnapshotQueryResult

{
    "0": "V",
    "1": "s",
    "2": "a",
    "3": "n",
    "4": "F",
    "5": "i",
    "6": "l",
    "7": "e",
    "8": "S",
    "9": "h",
    "10": "a",
    "11": "r",
    "12": "e",
    "13": "S",
    "14": "n",
    "15": "a",
    "16": "p",
    "17": "s",
    "18": "h",
    "19": "o",
    "20": "t",
    "21": "Q",
    "22": "u",
    "23": "e",
    "24": "r",
    "25": "y",
    "26": "R",
    "27": "e",
    "28": "s",
    "29": "u",
    "30": "l",
    "31": "t",
    "32": " ",
    "33": "O",
    "34": "b",
    "35": "j",
    "36": "e",
    "37": "c",
    "38": "t"
}

500

InvalidState: Exception for invalid states, for example, if vSAN file service is not enabled in this cluster.

InvalidArgument: Exception for invalid input arguments, for example, if the share does not exist in this cluster.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: InlineMethodFault0

"MethodFault Object"

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/VsanFileServiceSystem/{moId}/VsanClusterQueryShareSnapshots

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan File Service System Vsan Cluster Create Fs Domain