Get Cloud File System Details

Get details for an individual cloud file system.

Request

URI

GET

https://{orchestrator_fqdn}/api/vcdr/v1alpha/cloud-file-systems/{id}

COPY

Path Parameters

string

Required

The identifier of the cloud file system.

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

OK. The request succeeded.

Returns CloudFileSystemDetails of type(s) application/json

{
    "id": "string",
    "name": "string",
    "capacity_gib": "number",
    "used_gib": "number",
    "recovery_sddc_id": "string"
}

string

Optional

Cloud file system unique identifier.

string

name

Optional

The cloud file system name.

number As double As double

capacity_gib

Optional

The total physical storage capacity in gibibytes (GiB) of the individual cloud file system. The actual volume of data the cloud file system can contain is likely larger than this value.

number As double As double

used_gib

Optional

The total amount of used storage capacity in GiB of an individual cloud file system. The actual volume of used storage for the cloud file system is likely larger than this value.

string

recovery_sddc_id

Optional

The ID of the Recovery SDDC associated with this 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

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ]
        }
    ]
}

array of LocalizableMessage

messages

Optional

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

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors