REST Resource: projects.locations.rollouts

Resource: Peluncuran

Menampilkan satu eksekusi peluncuran dan hasilnya

Representasi JSON 
{
  "name": string,
  "release": string,
  "startTime": string,
  "endTime": string,
  "state": enum (RolloutState),
  "stateMessage": string,
  "stateTransitionTime": string,
  "rootRollout": string,
  "parentRollout": string,
  "rolloutOrchestrationStrategy": string,
  "unitFilter": string,
  "rolloutKind": string,
  "stats": {
    object (RolloutStats)
  },
  "control": {
    object (RolloutControl)
  },
  "effectiveUnitFilter": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string
}
Kolom
name

string

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

"projects/{project}/locations/{location}/rollout/{rolloutId}"
release

string

Opsional. Tidak dapat diubah. Nama Rilis yang di-roll out ke Unit target. Wajib diisi jika tidak ada jenis rilis lain yang ditentukan.
startTime

string (Timestamp format)

Opsional. Hanya output. Waktu saat peluncuran mulai dieksekusi. Akan kosong jika peluncuran belum dimulai.

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".
endTime

string (Timestamp format)

Opsional. Hanya output. Waktu saat peluncuran selesai dieksekusi (terlepas dari keberhasilan, kegagalan, atau pembatalan). Akan kosong jika peluncuran belum selesai. Setelah ditetapkan, peluncuran berada dalam status terminal dan semua hasilnya bersifat final.

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".
state

enum (RolloutState)

Hanya output. Status peluncuran saat ini.
stateMessage

string

Hanya output. Pesan yang dapat dibaca manusia yang menunjukkan detail tentang transisi status terakhir.
stateTransitionTime

string (Timestamp format)

Opsional. Hanya output. Waktu saat peluncuran bertransisi ke statusnya saat 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".
rootRollout

string

Opsional. Hanya output. Peluncuran root yang menjadi asal peluncuran ini. Nama resource (URI lengkap resource) yang mengikuti skema penamaan standar:

"projects/{project}/locations/{location}/rollouts/{rolloutId}"
parentRollout

string

Opsional. Hanya output. Peluncuran induk langsung yang berasal dari peluncuran ini. Nama resource (URI lengkap resource) yang mengikuti skema penamaan standar:

"projects/{project}/locations/{location}/rollouts/{rolloutId}"
rolloutOrchestrationStrategy

string

Opsional. Strategi yang digunakan untuk mengeksekusi Peluncuran ini. Strategi ini akan menggantikan strategi apa pun yang ditentukan dalam RolloutKind. Jika tidak ditentukan saat pembuatan, strategi dari RolloutKind akan digunakan.

Ada dua strategi nilai yang didukung yang digunakan untuk mengontrol - "Google.Cloud.Simple.AllAtOnce" - "Google.Cloud.Simple.OneLocationAtATime"

Peluncuran dengan salah satu strategi sederhana ini akan diluncurkan di semua lokasi yang ditentukan dalam Lokasi Saas UnitKind yang ditargetkan.
unitFilter

string

Opsional. String filter berformat CEL(https://github.com/google/cel-spec) terhadap Unit. Filter akan diterapkan untuk menentukan populasi unit yang memenuhi syarat. Filter ini hanya dapat mengurangi, tetapi tidak dapat memperluas cakupan peluncuran. Jika tidak disediakan, unitFilter dari RolloutKind akan digunakan.
rolloutKind

string

Opsional. Tidak dapat diubah. Nama RolloutKind yang menjadi asal dan diikuti oleh peluncuran ini.
stats

object (RolloutStats)

Opsional. Hanya output. Detail tentang progres peluncuran.
control

object (RolloutControl)

Opsional. Perubahan yang diminta pada pelaksanaan peluncuran ini. RolloutControl.action default adalah ROLLOUT_ACTION_RUN yang berarti peluncuran akan dieksekusi hingga selesai sambil berjalan melalui semua Status Peluncuran alami (seperti RUNNING -> SUCCEEDED atau RUNNING -> FAILED). Permintaan hanya dapat dibuat saat Peluncuran dalam status non-terminal.
effectiveUnitFilter

string

Opsional. Hanya output. Hanya menampilkan snapshot filter unit yang efektif pada waktu mulai Peluncuran. Berisi ekspresi CEL(https://github.com/google/cel-spec) yang terdiri dari konjungsi Rollout.unit_filter dan RolloutKind.unit_filter. Kolom ini mencatat filter yang diterapkan oleh Peluncuran untuk menentukan populasi Unit. Jika unitFilter RolloutKind terkait diubah setelah peluncuran dimulai, unitFilter tersebut tidak akan diperbarui di sini.
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".
deleteTime

string (Timestamp format)

Hanya output. Stempel waktu saat resource ditandai untuk dihapus (penghapusan adalah operasi asinkron).

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".

RolloutState

Status peluncuran saat ini.

Enum
ROLLOUT_STATE_UNSPECIFIED Status tidak ditentukan.
ROLLOUT_STATE_RUNNING Peluncuran sedang berlangsung.
ROLLOUT_STATE_PAUSED Peluncuran telah dijeda.
ROLLOUT_STATE_SUCCEEDED Peluncuran berhasil diselesaikan.
ROLLOUT_STATE_FAILED Peluncuran gagal.
ROLLOUT_STATE_CANCELLED Peluncuran telah dibatalkan.
ROLLOUT_STATE_WAITING Peluncuran menunggu beberapa kondisi terpenuhi sebelum dimulai.
ROLLOUT_STATE_CANCELLING Peluncuran sedang dibatalkan.
ROLLOUT_STATE_RESUMING Peluncuran dilanjutkan.
ROLLOUT_STATE_PAUSING Peluncuran sedang dijeda.

RolloutStats

RolloutStats berisi informasi tentang progres peluncuran.

Representasi JSON 
{
  "operationsByState": [
    {
      object (Aggregate)
    }
  ]
}
Kolom
operationsByState[]

object (Aggregate)

Opsional. Hanya output. Daftar yang tidak diurutkan. Perincian progres operasi yang dipicu oleh peluncuran. Menyediakan jumlah Operasi berdasarkan statusnya. Hal ini dapat digunakan untuk menentukan jumlah unit yang telah diperbarui, atau dijadwalkan untuk diperbarui.

Setiap grup akan memiliki maksimal satu entri. Kemungkinan nilai untuk grup operasi adalah: - "SCHEDULED" - "PENDING" - "RUNNING" - "SUCCEEDED" - "FAILED" - "CANCELLED"

Agregat

Mewakili penggabungan sekumpulan populasi dari rekaman serupa menurut grup tertentu. Misalnya, kumpulan jumlah unit dapat digabungkan dan dikelompokkan menurut statusnya.

Representasi JSON 
{
  "group": string,
  "count": integer
}
Kolom
group

string

Wajib. Grup yang akan dikelompokkan.
count

integer

Wajib. Jumlah data dalam grup.

RolloutControl

RolloutControl menyediakan cara untuk meminta perubahan pada eksekusi Peluncuran dengan menjeda atau membatalkannya.

Representasi JSON 
{
  "action": enum (RolloutAction),

  // Union field action_params can be only one of the following:
  "runParams": {
    object (RunRolloutActionParams)
  }
  // End of list of possible types for union field action_params.
}
Kolom
action

enum (RolloutAction)

Wajib. Tindakan yang akan dilakukan pada Peluncuran. Perilaku defaultnya adalah menjalankan peluncuran hingga mencapai status akhir secara alami.
Kolom union action_params. Setelan untuk tindakan. Setelan harus cocok dengan tindakan, misalnya: action=RUN hanya dapat menetapkan run_params atau menghapus semua parameter. Menetapkan setelan yang tidak berlaku untuk tindakan adalah suatu kesalahan. action_params hanya ada berupa salah satu diantara berikut:
runParams

object (RunRolloutActionParams)

Opsional. Parameter untuk tindakan RUN. Menentukan ini adalah error jika RolloutAction tidak disetel ke RUN. Secara default, peluncuran akan mencoba ulang operasi yang gagal saat dilanjutkan.

RunRolloutActionParams

Parameter untuk tindakan RUN yang mengontrol perilaku peluncuran saat dilanjutkan dari status PAUSED.

Representasi JSON 
{
  "retryFailedOperations": boolean
}
Kolom
retryFailedOperations

boolean

Wajib. Jika benar, peluncuran akan mencoba lagi operasi yang gagal saat dilanjutkan. Tindakan ini hanya berlaku jika status Peluncuran saat ini adalah PAUSED dan tindakan yang diminta adalah RUN.

RolloutAction

RolloutAction menunjukkan tindakan yang akan dilakukan pada Peluncuran.

Enum
ROLLOUT_ACTION_UNSPECIFIED Tindakan yang tidak ditentukan, akan diperlakukan sebagai RUN secara default.
ROLLOUT_ACTION_RUN Jalankan Rollout hingga mencapai status terminal secara alami. Peluncuran yang diminta untuk dijalankan akan melalui semua Status Peluncuran alami (seperti RUNNING -> SUCCEEDED atau RUNNING -> FAILED). Jika terjadi error yang dapat dicoba ulang selama peluncuran, peluncuran akan dijeda secara default dan dapat dilanjutkan dengan meminta kembali tindakan RUN ini.
ROLLOUT_ACTION_PAUSE Menjeda Peluncuran hingga dilanjutkan (yaitu, RUN diminta).
ROLLOUT_ACTION_CANCEL Membatalkan Peluncuran secara permanen.

Metode

create

 Buat peluncuran baru.

delete

 Menghapus satu peluncuran.

get

 Mengambil satu peluncuran.

list

 Mengambil kumpulan peluncuran.

patch

 Memperbarui satu peluncuran.