Sign in

v1

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

Creates a new RestorePlan in a given location.

post/v1/{+parent}/restorePlans

Path parameters

parentstring required

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

Query parameters

restorePlanIdstring

Required. The client-provided short name for the RestorePlan 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 RestorePlans in this location

Request body

descriptionstring

Optional. User specified descriptive string for this RestorePlan.

clusterstring

Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/*

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 GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

backupPlanstring

Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.

labelsobject

Optional. A set of custom labels supplied by user.

stateReasonstring

Output only. Human-readable description of why RestorePlan is in the 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.

updateTimestring google-datetime

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

uidstring

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

state'STATE_UNSPECIFIED' | 'CLUSTER_PENDING' | 'READY' | 'FAILED' | 'DELETING'

Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.

namestring

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

createTimestring google-datetime

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

restoreChannelstring

Output only. The fully qualified name of the RestoreChannel to be used to create a RestorePlan. This field is set only if the backup_plan is in a different project than the RestorePlan. Format: projects/*/locations/*/restoreChannels/*

Response

Successful response