Sign in

v1

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

Creates a new Restore for the given RestorePlan.

post/v1/{+parent}/restores

Path parameters

parentstring required

Required. The RestorePlan within which to create the Restore. Format: projects/*/locations/*/restorePlans/*

Query parameters

restoreIdstring

Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Restores in this RestorePlan.

Request body

resourcesFailedCountinteger

Output only. Number of resources that failed to be restored during the restore execution.

state'STATE_UNSPECIFIED' | 'CREATING' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' | 'DELETING' | 'VALIDATING'

Output only. The current state of the Restore.

resourcesExcludedCountinteger

Output only. Number of resources excluded during the restore execution.

namestring

Output only. Identifier. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*

createTimestring google-datetime

Output only. The timestamp when this Restore resource was created.

updateTimestring google-datetime

Output only. The timestamp when this Restore resource was last updated.

stateReasonstring

Output only. Human-readable description of why the Restore is in its current state. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent.

uidstring

Output only. Server generated global unique identifier of UUID format.

backupstring

Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.

labelsobject

A set of custom labels supplied by user.

etagstring

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource.

descriptionstring

Optional. User specified descriptive string for this Restore.

resourcesRestoredCountinteger

Output only. Number of resources restored during the restore execution.

clusterstring

Output only. The target cluster into which this Restore will restore data. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* Inherited from parent RestorePlan's cluster value.

completeTimestring google-datetime

Output only. Timestamp of when the restore operation completed.

volumesRestoredCountinteger

Output only. Number of volumes restored during the restore execution.

Response

Successful response