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

Get Protection Group Details

Description

Get details for the requested protection group.

Request

Request

URL

URL


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

Path Parameters

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ProtectionGroupDetails of type application/json

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
}
health Optional

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_UNKNOWNPG_HEALTH_OKPG_HEALTH_WARNINGPG_HEALTH_CRITICAL


string
id Optional

The unique identifier of the protection group.


members_specs Optional

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


string
name Optional

The name of the protection group.


string
protected_site_id Optional

The ID of the protected site associated with this 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.


snapshot_frequency_type Optional

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_UNKNOWNPG_SNAP_FREQ_TYPE_STANDARDPG_SNAP_FREQ_TYPE_HIGH


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.


boolean
snapshot_schedule_active Optional

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


number as double
used_gib Optional

The total amount of storage consumed by this protection group.

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}/protection-groups/{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?