Get Protection Group Details
DescriptionGet details for the requested protection group.
Request
URLURL
Path Parameters
Path Parameters
The cloud file system containing the protection group of interest.
The protection group of interest.
Authentication
Response
Response BodyResponse Body
200 OK
OK. The request succeeded.
{
"health": "PG_HEALTH_UNKNOWN",
"id": "string",
"members_specs": [
{
"vcenter_folder_paths": [
"string"
],
"vcenter_id": "string",
"vcenter_tags": [
"string"
],
"vcenter_vm_name_patterns": [
"string"
]
}
],
"name": "string",
"protected_site_id": "string",
"schedule_specs": [
{
"name": "string",
"retention_min": 0,
"schedule_spec": {
"day_of_month": 0,
"day_of_month_interval": 0,
"day_of_week": 0,
"day_of_week_interval": 0,
"hours": 0,
"hours_interval": 0,
"minutes": 0,
"minutes_interval": 0,
"month": 0,
"month_interval": 0
}
}
],
"snapshot_frequency_type": "PG_SNAP_FREQ_TYPE_UNKNOWN",
"snapshot_quiescing_enabled": false,
"snapshot_schedule_active": false,
"used_gib": 0
}
The health of a protection group.
- PG_HEALTH_UNKNOWN: The type of the protected site is unknown.
- PG_HEALTH_OK: There are no known problems.
- PG_HEALTH_WARNING: There issues that may require attention. Some VMs in the PG may not be protected in the most recent snapshot.
- PG_HEALTH_CRITICAL: The protection group is failing to work as intended.
Possible values are: PG_HEALTH_UNKNOWN , PG_HEALTH_OK , PG_HEALTH_WARNING , PG_HEALTH_CRITICAL
The unique identifier of the protection group.
The specifications used to determine the VMs contained in the protection group.
The name of the protection group.
The ID of the protected site associated with this protection group.
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.
The snapshot frequency of the protection group.
- PG_SNAP_FREQ_TYPE_UNKNOWN: It is not know what type of snapshots are being used by this protection group.
- PG_SNAP_FREQ_TYPE_STANDARD: Standard-frequency snapshots allow you to set snapshots schedules every hour to monthly.
- PG_SNAP_FREQ_TYPE_HIGH: High-frequency snapshots allow you to set snapshot schedules every 30 minutes to monthly.
Possible values are: PG_SNAP_FREQ_TYPE_UNKNOWN , PG_SNAP_FREQ_TYPE_STANDARD , PG_SNAP_FREQ_TYPE_HIGH
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.
Indicates if the protection group has a currently active snapshot schedule.
The total amount of storage consumed by this protection group.
Errors
Bad request. The server could not understand the request.
Unauthorized. The client has not authenticated.
Forbidden. The client is not authorized.
Not found. The server cannot find the specified resource.
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
Vendor Extensions
x-vcdr-roles-config:
mutatorMethod: false
roles:
- DR_ADMIN
- DR_TESTER
- BACKUP_ADMIN
- SERVICE_ADMIN
- SDDC_ADMIN
- AUDITOR
