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

vcdr

Get Protected Site Details

Description

Get details about an individual protected site.

Request

URL

get

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

Copy

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.

string

id Required

The unique identifier of the individual protected site for which you want to get details.

Authentication

This operation uses the following authentication methods.

api_key

Response

Response Body

200 OK

Returns ProtectedSiteDetails of type application/json

OK. The request succeeded.

{
	"id": "string",
	"name": "string",
	"type": "PROTECTED_SITE_TYPE_UNKNOWN"
}

string

id Optional

The identifier of the protected site.

string

name Optional

Name of the protected site.

ProtectedSiteType Enum

type Optional

The type of a protected site.

PROTECTED_SITE_TYPE_UNKNOWN: The type of the protected site is unknown.
PROTECTED_SITE_TYPE_ON_PREM: The protected site resides in a customer managed datacenter.
PROTECTED_SITE_TYPE_VMC: The protected site resides in a VMware Cloud (VMC) on AWS datacenter.

Possible values are: PROTECTED_SITE_TYPE_UNKNOWN , PROTECTED_SITE_TYPE_ON_PREM , PROTECTED_SITE_TYPE_VMC

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.

Error

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

cURL Command

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

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

Protected Site Operations

get

Get Protected Site Details

get

Get Protected Sites

Get Protected Site Details

Request

URL

Path Parameters

Authentication

api_key

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Protected Site Operations

Was this page helpful?