Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-134680139.0 KB
projects

Creates a backup from the volume specified in the request The backup can be created from the given snapshot if specified in the request. If no snapshot specified, there'll be a new snapshot taken to initiate the backup creation.

post/v1/{+parent}/backups

Path parameters

parentstring required

Required. The NetApp backupVault to create the backups of, in the format projects/*/locations/*/backupVaults/{backup_vault_id}

Query parameters

backupIdstring

Required. The ID to use for the backup. The ID must be unique within the specified backupVault. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Request body

sourceSnapshotstring

If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}

state'STATE_UNSPECIFIED' | 'CREATING' | 'UPLOADING' | 'READY' | 'DELETING' | 'ERROR' | 'UPDATING'

Output only. The backup state.

backupType'TYPE_UNSPECIFIED' | 'MANUAL' | 'SCHEDULED'

Output only. Type of backup, manually created or created by a backup policy.

chainStorageBytesstring int64

Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size)

satisfiesPzsboolean

Output only. Reserved for future use

satisfiesPziboolean

Output only. Reserved for future use

backupRegionstring

Output only. Region in which backup is stored. Format: projects/{project_id}/locations/{location}

sourceVolumestring

The resource name of the volume that this backup belongs to. You must provide either source_volume or ontap_source. Format: projects/{project_id}/locations/{location}/volumes/{volume_id}

createTimestring google-datetime

Output only. The time when the backup was created.

enforcedRetentionEndTimestring google-datetime

Output only. The time until which the backup is not deletable.

namestring

Identifier. The resource name of the backup. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}.

descriptionstring

A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.

labelsobject

Resource labels to represent user provided metadata.

volumeUsageBytesstring int64

Output only. Size of the file system when the backup was created. When creating a new volume from the backup, the volume capacity will have to be at least as big.

volumeRegionstring

Output only. Region of the volume from which the backup was created. Format: projects/{project_id}/locations/{location}

Response

Successful response