REST Resource: projects.locations.backupPlans

Referensi: BackupPlan

Menentukan konfigurasi dan penjadwalan untuk "baris" Pencadangan.

Representasi JSON 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "cluster": string,
  "retentionPolicy": {
    object (RetentionPolicy)
  },
  "labels": {
    string: string,
    ...
  },
  "backupSchedule": {
    object (Schedule)
  },
  "etag": string,
  "deactivated": boolean,
  "backupConfig": {
    object (BackupConfig)
  },
  "protectedPodCount": integer,
  "state": enum (State),
  "stateReason": string
}
Kolom
name

string

Hanya output. Nama lengkap resource BackupPlan. Format: projects/*/locations/*/backupPlans/*
uid

string

Hanya output. ID unik global yang dihasilkan server dalam format UUID.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat resource BackupPlan ini dibuat.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat resource BackupPlan ini terakhir diperbarui.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
description

string

String deskriptif yang ditentukan pengguna untuk BackupPlan ini.
cluster

string

Wajib. Tidak dapat diubah. Cluster sumber tempat Pencadangan akan dibuat melalui BackupPlan ini. Format yang valid:

  • projects/*/locations/*/clusters/*
  • projects/*/zones/*/clusters/*
retentionPolicy

object (RetentionPolicy)

RetentionPolicy mengatur siklus proses Cadangan yang dibuat berdasarkan rencana ini.
labels

map (key: string, value: string)

Sekumpulan label khusus yang disediakan oleh pengguna.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
backupSchedule

object (Schedule)

Menentukan jadwal untuk pembuatan Pencadangan otomatis melalui BackupPlan ini.
etag

string

Hanya output. etag digunakan untuk kontrol konkurensi optimistis sebagai cara untuk membantu mencegah pembaruan rencana cadangan secara bersamaan agar tidak saling menimpa satu sama lain. Sangat disarankan agar sistem menggunakan 'etag' dalam siklus baca-modifikasi-tulis untuk melakukan pembaruan BackupPlan guna menghindari kondisi race: etag ditampilkan sebagai respons terhadap backupPlans.get, dan sistem diharapkan untuk memasukkan etag tersebut dalam permintaan ke backupPlans.patch atau backupPlans.delete untuk memastikan bahwa perubahannya akan diterapkan ke versi resource yang sama.
deactivated

boolean

Tanda ini menunjukkan apakah BackupPlan ini telah dinonaktifkan. Menyetel kolom ini ke True akan mengunci BackupPlan sehingga tidak ada update lebih lanjut yang akan diizinkan (kecuali penghapusan), termasuk kolom yang dinonaktifkan itu sendiri. Hal ini juga mencegah pembuatan Cadangan baru melalui BackupPlan ini (termasuk Pencadangan terjadwal).

Default: Salah
backupConfig

object (BackupConfig)

Menentukan konfigurasi Pencadangan yang dibuat melalui BackupPlan ini.
protectedPodCount

integer

Hanya output. Jumlah Pod Kubernetes yang dicadangkan dalam Pencadangan terakhir yang berhasil dibuat melalui BackupPlan ini.
state

enum (State)

Hanya output. Status BackupPlan. Kolom Status ini mencerminkan berbagai tahap yang dapat dilakukan BackupPlan selama operasi Create. Opsi ini akan disetel ke "DEENABLEDD" jika BackupPlan dinonaktifkan saat Update
stateReason

string

Hanya output. Deskripsi yang dapat dibaca manusia tentang alasan BackupPlan ada di state saat ini

RetentionPolicy

RetentionPolicy menentukan kebijakan retensi cadangan untuk BackupPlan.

Representasi JSON 
{
  "backupDeleteLockDays": integer,
  "backupRetainDays": integer,
  "locked": boolean
}
Kolom
backupDeleteLockDays

integer

Usia minimum untuk Pencadangan yang dibuat melalui BackupPlan ini (dalam hari). Kolom ini HARUS berupa nilai bilangan bulat antara 0-90 (inklusif). Pencadangan yang dibuat pada BackupPlan ini TIDAK akan dapat dihapus hingga mencapai Backup (createTime + backupDeleteLockDays). Memperbarui kolom BackupPlan TIDAK memengaruhi Cadangan yang ada di bawahnya. Cadangan yang dibuat SETELAH update berhasil akan mewarisi nilai baru.

Default: 0 (tidak ada pemblokiran penghapusan)
backupRetainDays

integer

Usia maksimum default Pencadangan yang dibuat melalui BackupPlan ini. Kolom ini HARUS berupa nilai bilangan bulat >= 0 dan <= 365. Jika ditentukan, Pencadangan yang dibuat pada BackupPlan ini akan otomatis dihapus setelah usianya tercapai (createTime + backupRetainDays). Jika tidak ditentukan, Cadangan yang dibuat berdasarkan BackupPlan ini TIDAK akan dikenai penghapusan otomatis. Memperbarui kolom ini TIDAK memengaruhi Cadangan yang ada di bawahnya. Cadangan yang dibuat SETELAH update berhasil akan otomatis menggunakan nilai baru. CATATAN: backupRetainDays harus >= backupDeleteLockDays. Jika cronSchedule ditentukan, nilai ini harus <= 360 * interval pembuatan.

Default: 0 (tidak ada penghapusan otomatis)
locked

boolean

Tanda ini menunjukkan apakah kebijakan retensi BackupPlan ini dikunci. Jika disetel ke Benar (True), update lebih lanjut tidak akan diizinkan pada kebijakan ini, termasuk kolom locked itu sendiri.

Default: Salah

Jadwal

Menentukan parameter penjadwalan untuk membuat Cadangan secara otomatis melalui BackupPlan ini.

Representasi JSON 
{
  "cronSchedule": string,
  "paused": boolean
}
Kolom
cronSchedule

string

String cron standar yang menentukan jadwal berulang untuk membuat Pencadangan melalui BackupPlan ini. Hal ini tidak bisa ada pada saat yang sama dengan kolom rpoConfig karena maksimal satu jadwal dapat ditentukan untuk BackupPlan. Jika hal ini ditentukan, backupRetainDays juga harus ditentukan.

Default (kosong): tidak akan ada pembuatan cadangan otomatis.
paused

boolean

Tanda ini menunjukkan apakah pembuatan Pencadangan otomatis dijeda untuk BackupPlan ini.

Default: Salah

BackupConfig

BackupConfig menentukan konfigurasi Pencadangan yang dibuat melalui BackupPlan ini.

Representasi JSON 
{
  "includeVolumeData": boolean,
  "includeSecrets": boolean,
  "encryptionKey": {
    object (EncryptionKey)
  },

  // Union field backup_scope can be only one of the following:
  "allNamespaces": boolean,
  "selectedNamespaces": {
    object (Namespaces)
  },
  "selectedApplications": {
    object (NamespacedNames)
  }
  // End of list of possible types for union field backup_scope.
}
Kolom
includeVolumeData

boolean

Tanda ini menentukan apakah data volume harus dicadangkan saat PVC disertakan dalam cakupan Pencadangan.

Default: Salah
includeSecrets

boolean

Flag ini menentukan apakah resource Secret Kubernetes harus disertakan jika termasuk dalam cakupan Pencadangan.

Default: Salah
encryptionKey

object (EncryptionKey)

Kunci ini menentukan kunci enkripsi yang dikelola pelanggan, yang akan digunakan untuk mengenkripsi bagian "konfigurasi" (resource Kubernetes) Cadangan yang dibuat melalui paket ini.

Default (kosong): Artefak pencadangan konfigurasi tidak akan dienkripsi.
Kolom union backup_scope. Tindakan ini menentukan "cakupan" Pencadangan - resource dengan namespace dalam cluster akan disertakan di Pencadangan. Hanya salah satu kolom backup_scope HARUS ditentukan. backup_scope hanya ada berupa salah satu diantara berikut:
allNamespaces

boolean

Jika True, sertakan semua resource dengan namespace
selectedNamespaces

object (Namespaces)

Jika ditetapkan, sertakan hanya resource dalam namespace yang tercantum.
selectedApplications

object (NamespacedNames)

Jika disetel, sertakan hanya resource yang dirujuk oleh ProtectedApplications yang tercantum.

Negara bagian/Provinsi

Negara bagian/Provinsi

Enum
STATE_UNSPECIFIED Nilai pertama default untuk Enums.
CLUSTER_PENDING Menunggu status cluster DIJALANKAN.
PROVISIONING BackupPlan sedang dalam proses pembuatan.
READY BackupPlan telah berhasil dibuat dan siap untuk Pencadangan.
FAILED Pembuatan BackupPlan gagal.
DEACTIVATED BackupPlan telah dinonaktifkan.
DELETING BackupPlan sedang dalam proses dihapus.

Metode

create

 Membuat BackupPlan baru di lokasi tertentu.

delete

 Menghapus BackupPlan yang ada.

get

 Mengambil detail satu BackupPlan.

getIamPolicy

 Mendapatkan kebijakan kontrol akses untuk resource.

list

 Mencantumkan BackupPlans di lokasi tertentu.

patch

 Memperbarui BackupPlan.

setIamPolicy

 Menetapkan kebijakan kontrol akses pada resource yang ditentukan.

testIamPermissions

 Menampilkan izin yang dimiliki pemanggil atas resource yang ditentukan.