Get Protection Group Snapshot Details
DescriptionGet detailed information for a protection group snapshot.
Request
URLURL
Path Parameters
Path Parameters
The cloud file system containing the protection group snapshot of interest.
The protection group associated with the protection group snapshot of interest.
The protection group snapshot of interest.
Authentication
Response
Response BodyResponse Body
200 OK
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
}
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.
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.
The number of VMs that are defined by the protection group query but did not get included in the protection group snapshot.
The unique identifier of the protection group snapshot.
The name of the protection group snapshot.
The total data storage measured in GiB that is consumed by this protection group snapshot.
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_UNKNOWN , SNAPSHOT_TRIGGER_TYPE_MANUAL , SNAPSHOT_TRIGGER_TYPE_SCHEDULED
The unique data storage in GiB consumed by this protection group snapshot.
The number of VMs included in this protection group snapshot.
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
