Sign in

v1

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

Creates a new BackupPlan in a given location.

post/v1/{+parent}/backupPlans

Path parameters

parentstring required

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

Query parameters

backupPlanIdstring

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

Request body

descriptionstring

Optional. User specified descriptive string for this BackupPlan.

clusterstring

Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. 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 backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.

updateTimestring google-datetime

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

backupChannelstring

Output only. The fully qualified name of the BackupChannel to be used to create a backup. This field is set only if the cluster being backed up is in a different project. projects/*/locations/*/backupChannels/*

protectedPodCountinteger

Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

stateReasonstring

Output only. Human-readable description of why BackupPlan 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.

uidstring

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

lastSuccessfulBackupTimestring google-datetime

Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field. This field is added to maintain consistency with BackupPlanBinding to display last successful backup time.

labelsobject

Optional. A set of custom labels supplied by user.

deactivatedboolean

Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False

protectedNamespaceCountinteger

Output only. The number of user managed namespaces backed up in the last successful Backup created via this BackupPlan.

rpoRiskReasonstring

Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.

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

Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update

rpoRiskLevelinteger

Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.

namestring

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

createTimestring google-datetime

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

Response

Successful response