Vsan File Service System Vsan Cluster Query Share Snapshots

List all the snapshots that match the query spec.

Request

URI

POST

https://{vcenter-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.1.0.0 APIs.

Request Body

VsanClusterQueryShareSnapshotsRequestType of type(s) application/json

Required

Show optional properties

{
    "querySpec": {}
}

{
    "querySpec": {
        "_typeName": "string",
        "shareUuid": "string",
        "snapshotNames": [
            "string"
        ],
        "startTime": "string",
        "endTime": "string",
        "pageSize": 0,
        "pageNumber": 0
    },
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

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.

{
    "_typeName": "string",
    "snapshots": [
        {
            "_typeName": "string",
            "config": {
                "_typeName": "string",
                "shareUuid": "string",
                "name": "string"
            },
            "creationTime": "string",
            "usedCapacity": 0
        }
    ],
    "totalCount": 0
}

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: 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 '{"querySpec":"{}"}' 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