Sign in

v1

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

Creates a backup.

post/v1/{+parent}/backups

Path parameters

parentstring required

Required. The backup's project and location, in the format projects/{project_number}/locations/{location}. In Filestore, backup locations map to Google Cloud regions, for example us-west1.

Query parameters

backupIdstring

Required. The ID to use for the backup. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.

Request body

capacityGbstring int64

Output only. Capacity of the source file share when the backup was created.

satisfiesPzsboolean

Output only. Reserved for future use.

namestring

Output only. The resource name of the backup, in the format projects/{project_number}/locations/{location_id}/backups/{backup_id}.

createTimestring google-datetime

Output only. The time when the backup was created.

sourceInstancestring

The resource name of the source Filestore instance, in the format projects/{project_number}/locations/{location_id}/instances/{instance_id}, used to create this backup.

downloadBytesstring int64

Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage.

kmsKeystring

Immutable. KMS key name used for data encryption.

labelsobject

Resource labels to represent user provided metadata.

storageBytesstring int64

Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.

fileSystemProtocol'FILE_PROTOCOL_UNSPECIFIED' | 'NFS_V3' | 'NFS_V4_1'

Output only. The file system protocol of the source Filestore instance that this backup is created from.

descriptionstring

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

state'STATE_UNSPECIFIED' | 'CREATING' | 'FINALIZING' | 'READY' | 'DELETING' | 'INVALID'

Output only. The backup state.

sourceFileSharestring

Name of the file share in the source Filestore instance that the backup is created from.

satisfiesPziboolean

Output only. Reserved for future use.

sourceInstanceTier'TIER_UNSPECIFIED' | 'STANDARD' | 'PREMIUM' | 'BASIC_HDD' | 'BASIC_SSD' | 'HIGH_SCALE_SSD' | 'ENTERPRISE' | 'ZONAL' | 'REGIONAL'

Output only. The service tier of the source Filestore instance that this backup is created from.

tagsobject

Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value

Response

Successful response