Get Cloud File System Details

Get Cloud File System Details

Get details for an individual cloud file system.

Request
URI
GET
https://{api_host}/api/vcdr/v1/cloud-file-systems/{id}
COPY
Path Parameters
string
id
Required

The identifier of the cloud file system.


Authentication
This operation uses the following authentication methods.
Responses
200

OK. The request succeeded.

Returns CloudFileSystemDetails of type(s) application/json
{
    "id": "string",
    "name": "string",
    "size_tib": "number",
    "recovery_sddc_id": "string",
    "live_vms_number": 0,
    "vm_snapshot_count": 0
}
string
id
Optional

Cloud file system unique identifier.

string
name
Optional

The cloud file system name.

number As double As double
size_tib
Optional

The total amount of logical storage capacity used by an individual cloud file system.

string
recovery_sddc_id
Optional

The ID of the Recovery SDDC associated with this cloud file system.

integer As int32 As int32
live_vms_number
Optional

The number of live VMs for this cloud file system.

integer As int32 As int32
vm_snapshot_count
Optional

Number of virtual machine snapshots in the scalable cloud file system.


400

Bad request. The server could not understand the request.

Operation doesn't return any data structure

401

Unauthorized. The client has not authenticated.

Operation doesn't return any data structure

403

Forbidden. The client is not authorized.

Operation doesn't return any data structure

404

Not found. The server cannot find the specified resource.

Operation doesn't return any data structure

500

VMware Live Cyber Recovery-specific error.
An error unique to VMware Live Cyber Recovery was encountered while attempting to satisfy the request. See the returned object for details on the error.

Returns Error of type(s) application/json
"Error Object"
array of object
messages
Optional

A stack or error messages. The first element (top of the stack) is the broadest description of the failure.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcdr/v1/cloud-file-systems/{id}