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

Get Protection Group Snapshot Details

Description

Get detailed information for a protection group snapshot.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
cloud_file_system_id Required

The cloud file system containing the protection group snapshot of interest.


string
protection_group_id Required

The protection group associated with the protection group snapshot of interest.


string
id Required

The protection group snapshot of interest.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ProtectionGroupSnapshotDetails of type application/json

OK. The request succeeded.

{
	"creation_timestamp": 0,
	"expiration_timestamp": 0,
	"failed_vm_snap_count": 0,
	"id": "string",
	"name": "string",
	"total_used_data_gib": 0,
	"trigger_type": "SNAPSHOT_TRIGGER_TYPE_UNKNOWN",
	"unique_used_data_gib": 0,
	"vm_count": 0
}
integer as int64
creation_timestamp Optional

The time expressed as a Posix timestamp at which the protection group snapshot was created. Posix time is the number of seconds since the epoch 1970-01-01 00:00:00 UTC. For example: the timestap 1640143163 corresponds to 2021-12-22 3:19:23 UTC.


integer as int64
expiration_timestamp Optional

The time expressed as a Posix timestamp at which the protection group snapshot will expire and be automatically deleted. Posix time is the number of seconds since the epoch 1970-01-01 00:00:00 UTC. For example: the timestap 1640143163 corresponds to 2021-12-22 3:19:23 UTC.


integer as int32
failed_vm_snap_count Optional

The number of VMs that are defined by the protection group query but did not get included in the protection group snapshot.


string
id Optional

The unique identifier of the protection group snapshot.


string
name Optional

The name of the protection group snapshot.


number as double
total_used_data_gib Optional

The total data storage measured in GiB that is consumed by this protection group snapshot.


trigger_type Optional

The manner in which a protection group snapshot was triggered.

  • SNAPSHOT_TRIGGER_TYPE_UNKNOWN: The protection group snapshot trigger type is unknown.
  • SNAPSHOT_TRIGGER_TYPE_MANUAL: The protection group snapshot was triggered manually via the UI or API.
  • SNAPSHOT_TRIGGER_TYPE_SCHEDULED: The protection group was triggered by a schedule associated with the protection group.

Possible values are: SNAPSHOT_TRIGGER_TYPE_UNKNOWNSNAPSHOT_TRIGGER_TYPE_MANUALSNAPSHOT_TRIGGER_TYPE_SCHEDULED


number as double
unique_used_data_gib Optional

The unique data storage in GiB consumed by this protection group snapshot.


integer as int32
vm_count Optional

The number of VMs included in this protection group snapshot.

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/{protection_group_id}/snapshots/{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?