- Resource: Backup
- State
- BackupLock
- BackupApplianceLockInfo
- ServiceLockInfo
- ComputeInstanceBackupProperties
- Tags
- NetworkInterface
- AccessConfig
- AccessType
- NetworkTier
- AliasIpRange
- StackType
- Ipv6AccessType
- NicType
- AttachedDisk
- InitializeParams
- DiskType
- DiskMode
- DiskInterface
- GuestOsFeature
- FeatureType
- CustomerEncryptionKey
- DiskSavedState
- Metadata
- Entry
- ServiceAccount
- Scheduling
- OnHostMaintenance
- NodeAffinity
- Operator
- ProvisioningModel
- InstanceTerminationAction
- SchedulingDuration
- AcceleratorConfig
- KeyRevocationActionType
- BackupApplianceBackupProperties
- BackupType
- GCPBackupPlanInfo
- Methods
Resource: Backup
Message describing a Backup object.
JSON representation |
---|
{ "name": string, "labels": { string: string, ... }, "state": enum ( |
Fields | |
---|---|
name |
Output only. Identifier. Name of the backup to create. It must have the format |
labels |
Optional. Resource labels to represent user provided metadata. No labels currently defined. An object containing a list of |
state |
Output only. The Backup resource instance state. |
service |
Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup. |
backup |
Optional. The list of BackupLocks taken by the accessor Backup Appliance. |
backup |
Output only. Type of the backup, unspecified, scheduled or ondemand. |
resource |
Output only. source resource size in bytes at the time of the backup. |
description |
Output only. The description of the Backup instance (2048 characters or less). |
create |
Output only. The time when the instance was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
update |
Output only. The time when the instance was updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
enforced |
Optional. The backup can not be deleted before this time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
expire |
Optional. When this backup is automatically expired. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
consistency |
Output only. The point in time when this backup was captured from the source. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
etag |
Optional. Server specified ETag to prevent updates from overwriting each other. |
Union field backup_properties . Workload specific backup properties. backup_properties can be only one of the following: |
|
compute |
Output only. Compute Engine specific backup properties. |
backup |
Output only. Backup Appliance specific backup properties. |
Union field plan_info . Configuration Info has the resource format-specific configuration. plan_info can be only one of the following: |
|
gcp |
Output only. Configuration for a Google Cloud resource. |
State
Holds the state of the backup resource.
Enums | |
---|---|
STATE_UNSPECIFIED |
State not set. |
CREATING |
The backup is being created. |
ACTIVE |
The backup has been created and is fully usable. |
DELETING |
The backup is being deleted. |
ERROR |
The backup is experiencing an issue and might be unusable. |
BackupLock
BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
JSON representation |
---|
{ "lockUntilTime": string, // Union field |
Fields | |
---|---|
lock |
Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
Union field ClientLockInfo . Metadata about the owner and reason for the lock. ClientLockInfo can be only one of the following: |
|
backup |
If the client is a backup and recovery appliance, this contains metadata about why the lock exists. |
service |
Output only. Contains metadata about the lock exist for Google Cloud native backups. |
BackupApplianceLockInfo
BackupApplianceLockInfo contains metadata about the backupappliance that created the lock.
JSON representation |
---|
{ "backupApplianceId": string, "backupApplianceName": string, "lockReason": string, // Union field |
Fields | |
---|---|
backup |
Required. The ID of the backup/recovery appliance that created this lock. |
backup |
Required. The name of the backup/recovery appliance that created this lock. |
lock |
Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service. |
Union field lock_source . The information about this lock. lock_source can be only one of the following: |
|
job |
The job name on the backup/recovery appliance that created this lock. |
backup |
The image name that depends on this Backup. |
sla |
The SLA on the backup/recovery appliance that owns the lock. |
ServiceLockInfo
ServiceLockInfo represents the details of a lock taken by the service on a Backup resource.
JSON representation |
---|
{ "operation": string } |
Fields | |
---|---|
operation |
Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes. |
ComputeInstanceBackupProperties
ComputeInstanceBackupProperties represents Compute Engine instance backup properties.
JSON representation |
---|
{ "networkInterface": [ { object ( |
Fields | |
---|---|
network |
An array of network access configurations for this interface. |
disk[] |
An array of disks that are associated with the instances that are created from these properties. |
service |
A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances. |
guest |
A list of guest accelerator cards' type and count to use for instances created from these properties. |
labels |
Labels to apply to instances that are created from these properties. An object containing a list of |
description |
An optional text description for the instances that are created from these properties. |
tags |
A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). |
machine |
The machine type to use for instances that are created from these properties. |
can |
Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify |
metadata |
The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information. |
scheduling |
Specifies the scheduling options for the instances that are created from these properties. |
min |
Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as |
key |
KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. |
source |
The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance |
Tags
A set of instance tags.
JSON representation |
---|
{ "items": [ string ] } |
Fields | |
---|---|
items[] |
Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. |
NetworkInterface
A network interface resource attached to an instance. s
JSON representation |
---|
{ "accessConfigs": [ { object ( |
Fields | |
---|---|
access |
Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access. |
ipv6 |
Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. |
alias |
Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. |
network |
Optional. URL of the VPC network resource for this instance. |
subnetwork |
Optional. The URL of the Subnetwork resource for this instance. |
network |
Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. |
ipv6 |
Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork. |
internal |
Optional. The prefix length of the primary internal IPv6 range. |
name |
Output only. [Output Only] The name of the network interface, which is generated by the server. |
stack |
The stack type for this network interface. |
ipv6 |
Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. |
queue |
Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. |
nic |
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. |
network |
Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{projectNumber}/regions/{region_name}/networkAttachments/{network_attachment_name}. |
AccessConfig
An access configuration attached to an instance's network interface. Only one access config per instance is supported.
JSON representation |
---|
{ "type": enum ( |
Fields | |
---|---|
type |
Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. |
name |
Optional. The name of this access configuration. |
nat |
Optional. The external IP address of this access configuration. |
external |
Optional. The external IPv6 address of this access configuration. |
external |
Optional. The prefix length of the external IPv6 range. |
set |
Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. |
public |
Optional. The DNS domain name for the public PTR record. |
network |
Optional. This signifies the networking tier used for configuring this access |
AccessType
The type of configuration.
Enums | |
---|---|
ACCESS_TYPE_UNSPECIFIED |
Default value. This value is unused. |
ONE_TO_ONE_NAT |
ONE_TO_ONE_NAT |
DIRECT_IPV6 |
Direct IPv6 access. |
NetworkTier
Network tier property used by addresses, instances and forwarding rules.
Enums | |
---|---|
NETWORK_TIER_UNSPECIFIED |
Default value. This value is unused. |
PREMIUM |
High quality, Google-grade network tier, support for all networking products. |
STANDARD |
Public internet quality, only limited support for other networking products. |
AliasIpRange
An alias IP range attached to an instance's network interface.
JSON representation |
---|
{ "ipCidrRange": string, "subnetworkRangeName": string } |
Fields | |
---|---|
ip |
Optional. The IP alias ranges to allocate for this interface. |
subnetwork |
Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. |
StackType
Stack type for this network interface.
Enums | |
---|---|
STACK_TYPE_UNSPECIFIED |
Default should be STACK_TYPE_UNSPECIFIED. |
IPV4_ONLY |
The network interface will be assigned IPv4 address. |
IPV4_IPV6 |
The network interface can have both IPv4 and IPv6 addresses. |
Ipv6AccessType
IPv6 access type for this network interface.
Enums | |
---|---|
UNSPECIFIED_IPV6_ACCESS_TYPE |
IPv6 access type not set. Means this network interface hasn't been turned on IPv6 yet. |
INTERNAL |
This network interface can have internal IPv6. |
EXTERNAL |
This network interface can have external IPv6. |
NicType
Nic type for this network interface.
Enums | |
---|---|
NIC_TYPE_UNSPECIFIED |
Default should be NIC_TYPE_UNSPECIFIED. |
VIRTIO_NET |
VIRTIO |
GVNIC |
GVNIC |
AttachedDisk
An instance-attached disk resource.
JSON representation |
---|
{ "license": [ string ], "guestOsFeature": [ { object ( |
Fields | |
---|---|
license[] |
Optional. Any valid publicly visible licenses. |
guest |
Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. |
initialize |
Optional. Specifies the parameters to initialize this disk. |
device |
Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like diskName and replicaZones (in case of RePDs) |
kind |
Optional. Type of the resource. |
diskTypeDeprecated |
Specifies the type of the disk. |
mode |
Optional. The mode in which to attach this disk. |
source |
Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource. |
index |
Optional. A zero-based index to this disk, where 0 is reserved for the boot disk. |
boot |
Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
auto |
Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
disk |
Optional. Specifies the disk interface to use for attaching this disk. |
disk |
Optional. Encrypts or decrypts a disk using a customer-supplied encryption key. |
disk |
Optional. The size of the disk in GB. |
saved |
Optional. Output only. The state of the disk. |
disk |
Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd |
type |
Optional. Specifies the type of the disk. |
InitializeParams
Specifies the parameters to initialize this disk.
JSON representation |
---|
{ "replicaZones": [ string ], "diskName": string } |
Fields | |
---|---|
replica |
Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance. |
disk |
Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. |
DiskType
List of the Disk Types.
Enums | |
---|---|
DISK_TYPE_UNSPECIFIED |
Default value, which is unused. |
SCRATCH |
A scratch disk type. |
PERSISTENT |
A persistent disk type. |
DiskMode
List of the Disk Modes.
Enums | |
---|---|
DISK_MODE_UNSPECIFIED |
Default value, which is unused. |
READ_WRITE |
Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode. |
READ_ONLY |
Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time. |
LOCKED |
The disk is locked for administrative reasons. Nobody else can use the disk. This mode is used (for example) when taking a snapshot of a disk to prevent mounting the disk while it is being snapshotted. |
DiskInterface
List of the Disk Interfaces.
Enums | |
---|---|
DISK_INTERFACE_UNSPECIFIED |
Default value, which is unused. |
SCSI |
SCSI Disk Interface. |
NVME |
NVME Disk Interface. |
NVDIMM |
NVDIMM Disk Interface. |
ISCSI |
ISCSI Disk Interface. |
GuestOsFeature
Feature type of the Guest OS.
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
The ID of a supported feature. |
FeatureType
List of the Feature Types.
Enums | |
---|---|
FEATURE_TYPE_UNSPECIFIED |
Default value, which is unused. |
VIRTIO_SCSI_MULTIQUEUE |
VIRTIO_SCSI_MULTIQUEUE feature type. |
WINDOWS |
WINDOWS feature type. |
MULTI_IP_SUBNET |
MULTI_IP_SUBNET feature type. |
UEFI_COMPATIBLE |
UEFI_COMPATIBLE feature type. |
SECURE_BOOT |
SECURE_BOOT feature type. |
GVNIC |
GVNIC feature type. |
SEV_CAPABLE |
SEV_CAPABLE feature type. |
BARE_METAL_LINUX_COMPATIBLE |
BARE_METAL_LINUX_COMPATIBLE feature type. |
SUSPEND_RESUME_COMPATIBLE |
SUSPEND_RESUME_COMPATIBLE feature type. |
SEV_LIVE_MIGRATABLE |
SEV_LIVE_MIGRATABLE feature type. |
SEV_SNP_CAPABLE |
SEV_SNP_CAPABLE feature type. |
TDX_CAPABLE |
TDX_CAPABLE feature type. |
IDPF |
IDPF feature type. |
SEV_LIVE_MIGRATABLE_V2 |
SEV_LIVE_MIGRATABLE_V2 feature type. |
CustomerEncryptionKey
A customer-supplied encryption key.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field key . The key to use for encryption. key can be only one of the following: |
|
raw |
Optional. Specifies a 256-bit customer-supplied encryption key. |
rsa |
Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. |
kms |
Optional. The name of the encryption key that is stored in Google Cloud KMS. |
kms |
Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. |
DiskSavedState
List of the states of the Disk.
Enums | |
---|---|
DISK_SAVED_STATE_UNSPECIFIED |
Default Disk state has not been preserved. |
PRESERVED |
Disk state has been preserved. |
Metadata
A metadata key/value entry.
JSON representation |
---|
{
"items": [
{
object ( |
Fields | |
---|---|
items[] |
Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB. |
Entry
A key/value pair to be used for storing metadata.
JSON representation |
---|
{ "key": string, "value": string } |
Fields | |
---|---|
key |
Optional. Key for the metadata entry. |
value |
Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). |
ServiceAccount
A service account.
JSON representation |
---|
{ "scopes": [ string ], "email": string } |
Fields | |
---|---|
scopes[] |
Optional. The list of scopes to be made available for this service account. |
email |
Optional. Email address of the service account. |
Scheduling
Sets the scheduling options for an Instance.
JSON representation |
---|
{ "nodeAffinities": [ { object ( |
Fields | |
---|---|
node |
Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity. |
on |
Optional. Defines the maintenance behavior for this instance. |
automatic |
Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). |
preemptible |
Optional. Defines whether the instance is preemptible. |
min |
Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. |
provisioning |
Optional. Specifies the provisioning model of the instance. |
instance |
Optional. Specifies the termination action for the instance. |
local |
Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. |
OnHostMaintenance
Defines the maintenance behavior for this instance=
Enums | |
---|---|
ON_HOST_MAINTENANCE_UNSPECIFIED |
Default value. This value is unused. |
TERMINATE |
Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. |
MIGRATE |
Default, Allows Compute Engine to automatically migrate instances out of the way of maintenance events. |
NodeAffinity
Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
JSON representation |
---|
{
"values": [
string
],
"key": string,
"operator": enum ( |
Fields | |
---|---|
values[] |
Optional. Corresponds to the label values of Node resource. |
key |
Optional. Corresponds to the label key of Node resource. |
operator |
Optional. Defines the operation of node selection. |
Operator
Defines the type of node selections.
Enums | |
---|---|
OPERATOR_UNSPECIFIED |
Default value. This value is unused. |
IN |
Requires Compute Engine to seek for matched nodes. |
NOT_IN |
Requires Compute Engine to avoid certain nodes. |
ProvisioningModel
Defines the provisioning model for an instance.
Enums | |
---|---|
PROVISIONING_MODEL_UNSPECIFIED |
Default value. This value is not used. |
STANDARD |
Standard provisioning with user controlled runtime, no discounts. |
SPOT |
Heavily discounted, no guaranteed runtime. |
InstanceTerminationAction
Defines the supported termination actions for an instance.
Enums | |
---|---|
INSTANCE_TERMINATION_ACTION_UNSPECIFIED |
Default value. This value is unused. |
DELETE |
Delete the VM. |
STOP |
Stop the VM without storing in-memory content. default action. |
SchedulingDuration
A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years.
JSON representation |
---|
{ "seconds": string, "nanos": integer } |
Fields | |
---|---|
seconds |
Optional. Span of time at a resolution of a second. |
nanos |
Optional. Span of time that's a fraction of a second at nanosecond resolution. |
AcceleratorConfig
A specification of the type and number of accelerator cards attached to the instance.
JSON representation |
---|
{ "acceleratorType": string, "acceleratorCount": integer } |
Fields | |
---|---|
accelerator |
Optional. Full or partial URL of the accelerator type resource to attach to this instance. |
accelerator |
Optional. The number of the guest accelerator cards exposed to this instance. |
KeyRevocationActionType
Specifies whether the virtual machine instance will be shut down on key revocation. It is currently used in instance, instance properties and GMI protos
Enums | |
---|---|
KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED |
Default value. This value is unused. |
NONE |
Indicates user chose no operation. |
STOP |
Indicates user chose to opt for VM shutdown on key revocation. |
BackupApplianceBackupProperties
BackupApplianceBackupProperties represents BackupDR backup appliance's properties.
JSON representation |
---|
{ "generationId": integer, "finalizeTime": string, "recoveryRangeStartTime": string, "recoveryRangeEndTime": string } |
Fields | |
---|---|
generation |
Output only. The numeric generation ID of the backup (monotonically increasing). |
finalize |
Output only. The time when this backup object was finalized (if none, backup is not finalized). A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
recovery |
Optional. The earliest timestamp of data available in this Backup. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
recovery |
Optional. The latest timestamp of data available in this Backup. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
BackupType
Type of the backup, scheduled or ondemand.
Enums | |
---|---|
BACKUP_TYPE_UNSPECIFIED |
Backup type is unspecified. |
SCHEDULED |
Scheduled backup. |
ON_DEMAND |
On demand backup. |
GCPBackupPlanInfo
GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup.
JSON representation |
---|
{ "backupPlan": string, "backupPlanRuleId": string } |
Fields | |
---|---|
backup |
Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} |
backup |
The rule id of the backup plan which triggered this backup in case of scheduled backup or used for |
Methods |
|
---|---|
|
Deletes a Backup. |
|
Gets details of a Backup. |
|
Lists Backups in a given project and location. |
|
Updates the settings of a Backup. |
|
Restore from a Backup |