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

Get Protected Sites

Description

Get a list of all protected sites associated with an individual cloud file system.

Request

Request

URL

URL


get
https://{orchestrator_fqdn}/api/vcdr/v1alpha/cloud-file-systems/{cloud_file_system_id}/protected-sites
Copy

Path Parameters

Path Parameters

string
cloud_file_system_id Required

Unique identifier of an individual cloud file system. Use the cloud file system ID of the cloud file system for which you want to get a list of all protected sites.


Query Parameters

Query Parameters

string
cursor Optional

An opaque string previously returned by this API that can be passed to this API in order to get the next set of results. If this property is not passed, enumeration of starts from the beginning.

Note: The pre-release version of this API differs from this documentation. This parameter is ignored. All protected sites are returned when making this API call.


filter_spec Optional

Used to filter the results.

Note: The pre-release version of this API differs from this documentation. This parameter is ignored. All protected sites are returned.


integer
limit Optional

The maximum number of results to return with the call. The maximum is 500, and the default is 50 results.

Note: The pre-release version of this API differs from this documentation. This parameter is ignored.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns GetProtectedSitesResponse of type application/json

OK. The request succeeded.

{
	"cursor": "string",
	"protected_sites": [
		{
			"id": "string",
			"name": "string"
		}
	]
}
string
cursor Optional

An opaque string that can be passed back to this API in order to get the next set of results. If this poperty is not present, no more results are available.


protected_sites Optional

An array of summary information concerning protected sites.

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/{cloud_file_system_id}/protected-sites
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?