REST Resource: projects.locations.units

Resource: Unit

Unit deployment yang memiliki siklus prosesnya melalui CRUD API menggunakan mesin aktuasi di balik layar (misalnya, berdasarkan Terraform, Helm, atau penerapan kustom yang disediakan oleh produsen layanan). Blok penyusun Tenant SaaS.

Representasi JSON 
{
  "name": string,
  "unitKind": string,
  "release": string,
  "tenant": string,
  "ongoingOperations": [
    string
  ],
  "pendingOperations": [
    string
  ],
  "scheduledOperations": [
    string
  ],
  "dependents": [
    {
      object (UnitDependency)
    }
  ],
  "dependencies": [
    {
      object (UnitDependency)
    }
  ],
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ],
  "outputVariables": [
    {
      object (UnitVariable)
    }
  ],
  "maintenance": {
    object (MaintenanceSettings)
  },
  "state": enum (UnitState),
  "conditions": [
    {
      object (UnitCondition)
    }
  ],
  "managementMode": enum (ManagementMode),
  "systemManagedState": enum (SystemManagedState),
  "systemCleanupAt": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Kolom
name

string

ID. Nama resource (URI lengkap resource) yang mengikuti skema penamaan standar:

"projects/{project}/locations/{location}/units/{unit}"
unitKind

string

Opsional. Referensi ke UnitKind tempat Unit ini berada. Tidak dapat diubah setelah ditetapkan.
release

string

Opsional. Hanya output. Objek Rilis saat ini untuk Unit ini.
tenant

string

Opsional. Referensi ke resource Saas Tenant yang memiliki unit ini. Misalnya, hal ini memberi tahu kebijakan pemeliharaan yang akan digunakan untuk menjadwalkan update mendatang pada unit. (opsional dan tidak dapat diubah setelah dibuat)
ongoingOperations[]

string

Opsional. Hanya output. Daftar UnitOperation serentak yang beroperasi di Unit ini.
pendingOperations[]

string

Opsional. Hanya output. Daftar UnitOperation yang tertunda (menunggu untuk dieksekusi) untuk unit ini.
scheduledOperations[]

string

Opsional. Hanya output. Daftar UnitOperation terjadwal untuk unit ini.
dependents[]

object (UnitDependency)

Opsional. Hanya output. Daftar Unit yang bergantung pada unit ini. Unit hanya dapat dihentikan penyediaannya jika daftar ini kosong. Maksimum 1000.
dependencies[]

object (UnitDependency)

Opsional. Hanya output. Set dependensi untuk unit ini. Maksimum 10.
inputVariables[]

object (UnitVariable)

Opsional. Hanya output. Menunjukkan variabel input saat ini yang di-deploy oleh unit
outputVariables[]

object (UnitVariable)

Opsional. Hanya output. Kumpulan pasangan kunci/nilai yang sesuai dengan variabel output dari eksekusi template aktuasi. Variabel dideklarasikan dalam konfigurasi aktuasi (misalnya, dalam helm chart atau terraform) dan nilai diambil serta ditampilkan oleh mesin aktuasi setelah eksekusi selesai.
maintenance

object (MaintenanceSettings)

Opsional. Mencatat arahan yang diminta untuk melakukan pemeliharaan unit di masa mendatang. Hal ini mencakup permintaan agar unit melewati pemeliharaan selama jangka waktu tertentu dan tetap disematkan ke rilis saat ini serta kontrol untuk menunda pemeliharaan yang dijadwalkan pada masa mendatang.
state

enum (UnitState)

Opsional. Hanya output. Status siklus proses resource saat ini (misalnya, jika sedang dibuat atau siap digunakan).
conditions[]

object (UnitCondition)

Opsional. Hanya output. Serangkaian kondisi yang menunjukkan berbagai kondisi yang dapat dimiliki resource ini.
managementMode

enum (ManagementMode)

Opsional. Tidak dapat diubah. Menunjukkan apakah Siklus proses unit dikontrol oleh pengguna atau oleh sistem. Tidak dapat diubah setelah dibuat.
systemManagedState

enum (SystemManagedState)

Opsional. Hanya output. Menunjukkan status unit yang dikelola sistem.
systemCleanupAt

string (Timestamp format)

Opsional. Hanya output. Jika disetel, menunjukkan waktu saat sistem akan mulai menghapus unit.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Opsional. Label pada resource, yang dapat digunakan untuk kategorisasi, mirip dengan label resource Kubernetes.

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

map (key: string, value: string)

Opsional. Anotasi adalah peta nilai kunci tidak terstruktur yang disimpan dengan resource yang dapat ditetapkan oleh alat eksternal untuk menyimpan dan mengambil metadata arbitrer. Objek ini tidak dapat dikueri dan harus dipertahankan saat mengubah objek.

Info selengkapnya: https://kubernetes.io/docs/user-guide/annotations

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

string

Hanya output. ID unik resource. UID bersifat unik dalam waktu dan ruang untuk resource ini dalam cakupan layanan. ID ini biasanya dibuat oleh server saat resource berhasil dibuat dan tidak boleh diubah. UID digunakan untuk mengidentifikasi resource secara unik dengan penggunaan ulang nama resource. Nilai ini harus berupa UUID4.
etag

string

Hanya output. Nilai buram yang secara unik mengidentifikasi versi atau generasi resource. Nilai ini dapat digunakan untuk mengonfirmasi bahwa klien dan server menyetujui pengurutan resource yang sedang ditulis.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat resource dibuat.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat resource terakhir diperbarui. Setiap perubahan pada resource yang dilakukan oleh pengguna harus memperbarui nilai ini. Perubahan pada resource yang dilakukan oleh layanan harus memperbarui nilai ini.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
satisfiesPzs

boolean

Hanya output. Menunjukkan apakah lokasi resource memenuhi batasan Pemisahan Zona. Opsi ini false secara default.
satisfiesPzi

boolean

Hanya output. Menunjukkan apakah lokasi resource memenuhi batasan Isolasi Zona. Opsi ini false secara default.

UnitDependency

Set dependensi untuk unit ini. Maksimum 10.

Representasi JSON 
{
  "alias": string,
  "unit": string
}
Kolom
alias

string

Hanya output. Alias untuk nama dependensi.
unit

string

Hanya output. Referensi ke objek Unit.

MaintenanceSettings

Mencatat arahan yang diminta untuk melakukan pemeliharaan unit di masa mendatang. Hal ini mencakup permintaan agar unit melewati pemeliharaan selama jangka waktu tertentu dan tetap disematkan ke rilis saat ini serta kontrol untuk menunda pemeliharaan yang dijadwalkan pada masa mendatang.

Representasi JSON 
{
  "pinnedUntilTime": string
}
Kolom
pinnedUntilTime

string (Timestamp format)

Opsional. Jika ada, akan memperbaiki rilis di unit hingga waktu yang ditentukan; yaitu perubahan pada kolom rilis akan ditolak. Peluncuran juga harus dan akan mematuhi hal ini dengan tidak meminta upgrade sejak awal.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

UnitState

UnitState menganotasi status unit itu sendiri saat ini.

Enum
UNIT_STATE_UNSPECIFIED Status tidak ditentukan.
UNIT_STATE_NOT_PROVISIONED Unit tidak disediakan.
UNIT_STATE_PROVISIONING Unit sedang disediakan.
UNIT_STATE_UPDATING Unit sedang diperbarui. Hal ini biasanya terjadi saat unit diupgrade ke rilis baru atau beberapa variabel input pada Unit diubah. Jenis update tertentu dapat menyebabkan Unit tidak dapat digunakan saat update sedang berlangsung.
UNIT_STATE_DEPROVISIONING Unit sedang dihapus.
UNIT_STATE_READY Unit telah disediakan dan siap digunakan
UNIT_STATE_ERROR Unit mengalami error, saat tidak siap dan beberapa operasi error

UnitCondition

UnitCondition menjelaskan status Unit. UnitCondition adalah komponen individual yang berkontribusi pada status keseluruhan.

Representasi JSON 
{
  "status": enum (Status),
  "type": enum (Type),
  "lastTransitionTime": string,
  "message": string,
  "reason": string
}
Kolom
status

enum (Status)

Wajib. Status kondisi.
type

enum (Type)

Wajib. Jenis kondisi.
lastTransitionTime

string (Timestamp format)

Wajib. Terakhir kali kondisi bertransisi dari satu status ke status lainnya.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
message

string

Wajib. Pesan yang dapat dibaca manusia yang menunjukkan detail tentang transisi terakhir.
reason

string

Wajib. Alasan singkat untuk transisi terakhir kondisi.

Status

Enumerasi status kondisi.

Enum
STATUS_UNSPECIFIED Status kondisi tidak ditentukan.
STATUS_UNKNOWN Kondisi tidak diketahui.
STATUS_TRUE Kondisinya benar.
STATUS_FALSE Kondisinya salah.

Jenis

Enumerasi jenis kondisi.

Enum
TYPE_UNSPECIFIED Jenis kondisi tidak ditentukan.
TYPE_READY Jenis kondisi sudah siap.
TYPE_UPDATING Jenis kondisi sedang diperbarui.
TYPE_PROVISIONED Jenis kondisi disediakan.
TYPE_OPERATION_ERROR Jenis kondisi adalah operationError. Benar (True) jika operasi unit terakhir gagal dengan error yang tidak dapat diabaikan.

ManagementMode

ManagementMode menjelaskan siapa yang bertanggung jawab atas pengelolaan unit.

Enum
MANAGEMENT_MODE_UNSPECIFIED
MANAGEMENT_MODE_USER Siklus proses unit dikelola oleh pengguna.
MANAGEMENT_MODE_SYSTEM Sistem akan memutuskan kapan harus mencabut akses dan menghapus unit. Pengguna tetap dapat membatalkan penyediaan atau menghapus unit secara manual.

SystemManagedState

Enum
SYSTEM_MANAGED_STATE_UNSPECIFIED
SYSTEM_MANAGED_STATE_ACTIVE Unit memiliki dependen yang dilampirkan.
SYSTEM_MANAGED_STATE_INACTIVE Unit tidak memiliki dependensi yang dilampirkan, tetapi lampiran diizinkan.
SYSTEM_MANAGED_STATE_DECOMMISSIONED Unit tidak memiliki lampiran dependensi, dan lampiran tidak diizinkan.

Metode

create

 Buat unit baru.

delete

 Menghapus satu unit.

get

 Mengambil satu unit.

list

 Mengambil kumpulan unit.

patch

 Memperbarui satu unit.