Get Protection Group Details

Get Protection Group Details

Get details for the requested protection group.

Request
URI
GET
https://{orchestrator_fqdn}/api/vcdr/v1alpha/cloud-file-systems/{cloud_file_system_id}/protection-groups/{id}
COPY
Path Parameters
string
cloud_file_system_id
Required

The cloud file system containing the protection group of interest.

string
id
Required

The protection group of interest.


Authentication
This operation uses the following authentication methods.
Responses
200

OK. The request succeeded.

Returns ProtectionGroupDetails of type(s) application/json
{
    "id": "string",
    "name": "string",
    "health": "string",
    "members_specs": [
        {
            "vcenter_id": "string",
            "vcenter_vm_name_patterns": [
                "string"
            ],
            "vcenter_tags": [
                "string"
            ],
            "vcenter_folder_paths": [
                "string"
            ]
        }
    ],
    "schedule_specs": [
        {
            "name": "string",
            "schedule_spec": {
                "minutes": 0,
                "minutes_interval": 0,
                "hours": 0,
                "hours_interval": 0,
                "day_of_month": 0,
                "day_of_month_interval": 0,
                "month": 0,
                "month_interval": 0,
                "day_of_week": 0,
                "day_of_week_interval": 0
            },
            "retention_min": 0
        }
    ],
    "protected_site_id": "string",
    "snapshot_schedule_active": false,
    "snapshot_frequency_type": "string",
    "snapshot_quiescing_enabled": false,
    "used_gib": "number"
}
string
id
Optional

The unique identifier of the protection group.

string
name
Optional

The name of the protection group.

health
Optional

health

members_specs
Optional

The specifications used to determine the VMs contained in the protection group.

schedule_specs
Optional

The specifications used to determine when snapshots are taken of the protection group.

Note: The pre-release version of this API differs from this documentation. This field is not currently provided.

string
protected_site_id
Optional

The ID of the protected site associated with this protection group.

boolean
snapshot_schedule_active
Optional

Indicates if the protection group has a currently active snapshot schedule.

snapshot_frequency_type
Optional

snapshot_frequency_type

boolean
snapshot_quiescing_enabled
Optional

Indicates if quiescing is enabled for this protection group. For VMs with VMware Tools installed, you can create protection groups to take quiesced snapshots. Quiescing pauses or alters the state of running processes on the VM to guarantee a consistent state of applications.

number As double As double
used_gib
Optional

The total amount of storage consumed by this protection group.


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"
            ]
        }
    ]
}
messages
Optional

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