[{"label":"Latest (1.0.0alpha)","version":"latest"}]
vcdr

Get Cloud File System Details

Description

Get details for an individual cloud file system.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
id Required

The identifier of the cloud file system.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns CloudFileSystemDetails of type application/json

OK. The request succeeded.

{
	"capacity_gib": 0,
	"id": "string",
	"name": "string",
	"recovery_sddc_id": "string",
	"used_gib": 0
}
number 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.


string
id Optional

Cloud file system unique identifier.


string
name Optional

The cloud file system name.


string
recovery_sddc_id Optional

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


number 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.

Errors

Errors

400

Bad request. The server could not understand the request.


401

Unauthorized. The client has not authenticated.


403

Forbidden. The client is not authorized.


404

Not found. The server cannot find the specified resource.


500

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

Code Samples

Code Samples

cURL Command

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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-vcdr-roles-config:
    mutatorMethod: false
    roles:
        - DR_ADMIN
        - DR_TESTER
        - BACKUP_ADMIN
        - SERVICE_ADMIN
        - SDDC_ADMIN
        - AUDITOR


[{"label":"Latest (1.0.0alpha)","version":"latest"}]
vcdr
Feedback

Was this page helpful?