Membuat dan mengonfigurasi cron job

Target Pub/Sub

Jika Anda memilih jenis target Pub/Sub:

1. Tentukan nama topik tempat tugas akan dipublikasikan. Ini adalah topik Pub/Sub yang telah Anda siapkan di project Anda.

2. Tentukan pesan yang akan dikirim ke topik. ID ini dikirim sebagai parameter data dalam pesan Pub/Sub. Untuk contoh yang melakukan hal ini, lihat Panduan Memulai.

3. Tambahkan atribut pesan yang Anda perlukan.

4. Siapkan konfigurasi tambahan apa pun menggunakan bagian Configure optional settings.

Cloud Scheduler akan memublikasikan pesan ke topik ini sebagai akun layanan Google API.

Oke

Target HTTP App Engine

Jika memilih jenis target App Engine HTTP, Anda harus menggunakan aplikasi App Engine dan region yang terkait dengan project saat ini. Jika Anda ingin menggunakan aplikasi App Engine lain di luar project saat ini, pilih HTTP sebagai target, bukan App Engine HTTP. Aturan firewall target harus mengizinkan permintaan dari rentang IP 0.1.0.2/32.

Tetapkan formulir sebagai berikut:

1. Dalam daftar Target type, pilih App Engine HTTP.

2. Tentukan nama layanan App Engine yang menjalankan pengendali untuk tugas Cloud Scheduler. Jika dihilangkan, layanan default diasumsikan. Jika ingin menyetelnya, Anda dapat menemukan nama layanannya di Google Cloud Console.

3. (Opsional) Tentukan versi. Jika tidak disetel, versi yang saat ini ditayangkan akan digunakan. Anda dapat menemukan versi yang tersedia di Google Cloud Console.

4. (Opsional) Tentukan instance. Jika tidak disetel, instance apa pun yang tersedia dapat digunakan. Anda dapat menemukan versi yang tersedia di Google Cloud Console.

5. Tentukan URL relatif endpoint App Engine yang akan dihubungi oleh tugas. Jika Anda menggunakan nilai default /, tugas akan menggunakan PROJECT-ID.appspot.com, dengan PROJECT-ID yang merupakan project ID Anda saat ini.

   Catatan: Jika Anda tidak menggunakan layanan default, URL target yang ditampilkan di UI Google Cloud Console adalah dalam bentuk SERVICE.PROJECT-ID.r.appspot.com/*. URL yang sama yang ditampilkan di jendela terminal menggunakan CLI adalah dalam bentuk https://SERVICE-dot-PROJECT-ID.r.appspot.com/. Kedua formulir ini setara.

6. Tetapkan metode HTTP yang ingin Anda gunakan saat tugas dieksekusi. Default-nya adalah POST.

7. Tambahkan header yang Anda perlukan ke permintaan.

8. (Opsional) Tentukan data isi yang akan dikirim ke target. Data ini dikirim dalam isi permintaan sebagai byte saat metode HTTP POST atau PUT dipilih.

Endpoint App Engine yang ditargetkan harus berada dalam project yang sama dan dapat diamankan dengan login: admin pada elemen handlers di file app.yaml.

Oke

Target HTTP

Jika Anda memilih jenis target HTTP:

1. Tentukan URL endpoint yang sepenuhnya memenuhi syarat yang akan dihubungi oleh tugas.

2. Tentukan metode HTTP. Nilai defaultnya adalah POST.

3. (Opsional) Tentukan data yang akan dikirim ke target. Data ini dikirim dalam isi permintaan sebagai byte jika metode HTTP POST atau PUT dipilih.

4. Tambahkan header yang Anda butuhkan.

5. Untuk membuat tugas target HTTP yang memerlukan autentikasi, lihat Menggunakan autentikasi dengan target HTTP.

Endpoint HTTP yang ditargetkan harus dapat diakses secara publik.

Catatan: Saat menggunakan target HTTP, Cloud Scheduler mungkin melaporkan error permintaan gagal meskipun target berhasil ditampilkan. Hal ini dapat terjadi jika ada ketidakcocokan antara setelan waktu tunggu layanan target dan setelan Cloud Scheduler. Lihat deskripsi tugas untuk menetapkan kolom attempt_deadline.

Oke

Anda dapat menggunakan Cloud Scheduler untuk menyiapkan unit tugas terjadwal, yang disebut cron job, yang dikirim ke target pada beberapa jadwal berulang, yang juga disebut interval atau frekuensi tugas.

Hanya satu instance tugas yang harus dijalankan kapan saja. Dalam situasi yang jarang terjadi, beberapa instance dari tugas yang sama dapat diminta. Akibatnya, pengendali permintaan Anda harus idempoten, dan kode Anda harus memastikan bahwa tidak ada efek samping yang berbahaya jika hal ini terjadi.

Catatan: Cloud Scheduler menyediakan headers yang dapat membantu menghapus duplikat permintaan tugas, sehingga pengendali permintaan menjadi idempoten. Secara khusus, permintaan tugas dapat diidentifikasi secara unik menggunakan nama tugas dan waktu tugasnya dijadwalkan.

Cloud Scheduler ditujukan untuk mengulangi tugas. Jika Anda hanya perlu menjalankan tugas satu kali, pertimbangkan untuk menggunakan Cloud Tasks, yang dapat menjadwalkan tugas hingga 30 hari sebelumnya.

Sebelum memulai

Pastikan Anda telah menyiapkan lingkungan Anda untuk Cloud Scheduler.

Pilih jenis target

Cloud Scheduler dapat memanggil jenis target berikut:

• Endpoint HTTP

• Topik Pub/Sub

• Layanan App Engine

Memanggil layanan target yang dibatasi untuk traffic masuk internal

Cloud Scheduler dapat memanggil layanan berikut secara internal:

• Cloud Functions
• Cloud Run (di URL run.app, bukan di domain kustom)

Untuk memanggil target ini secara internal, target harus berada di perimeter project Google Cloud atau Kontrol Layanan VPC yang sama dengan tugas Cloud Scheduler Anda.

Untuk mempelajari lebih lanjut cara mengamankan target dengan membatasi ingress, lihat Membatasi ingress (untuk Cloud Run) dan Mengonfigurasi setelan jaringan (untuk Cloud Functions).

Membuat tugas

Anda dapat membuat tugas menggunakan konsol Google Cloud atau Google Cloud CLI.

Konsol

1. Di konsol Google Cloud, buka Cloud Scheduler.
   

   Buka Cloud Scheduler

2. Klik Buat tugas.

3. Di kolom Name, berikan nama unik untuk project.

   Setelah menghapus tugas terkaitnya, Anda dapat menggunakan kembali nama tugas dalam sebuah project.

4. Dalam daftar Region, pilih wilayah.

   Jika menggunakan target HTTP App Engine, Anda harus memilih region yang sama dengan aplikasi App Engine Anda. Untuk informasi selengkapnya, lihat Wilayah yang didukung menurut target.

5. Jika ingin, berikan deskripsi singkat tentang pekerjaan, seperti pengingat tentang apa yang dilakukan pekerjaan tersebut.

   Deskripsi ini muncul di konsol di samping nama pekerjaan.

6. Tentukan frekuensi saat tugas akan dijalankan, menggunakan string konfigurasi.

   Misalnya, string 0 1 * * 0 menjalankan tugas seminggu sekali pada pukul 01.00 setiap Minggu pagi. String yang Anda berikan di sini dapat berupa string apa pun yang kompatibel dengan unix-cron. Untuk informasi selengkapnya, lihat Mengonfigurasi jadwal cron job.

7. Di daftar Zona Waktu, pilih zona waktu yang akan digunakan untuk jadwal kerja.

8. Klik Lanjutkan.

9. Tentukan Target type:

   • HTTP

   • Pub/Sub: Anda harus menentukan nama topik Pub/Sub yang telah disiapkan di project dan tujuan publikasi tugas.

   • App Engine HTTP: Anda harus menggunakan aplikasi App Engine dan region yang terkait dengan project saat ini.

10. Klik Lanjutkan.

11. Secara opsional, untuk mengonfigurasi perilaku percobaan ulang, klik Configure opsional setelan. Untuk menentukan durasi, gunakan urutan bilangan bulat non-negatif desimal dengan akhiran satuan berikut:

    • j - jam
    • m - menit
    • d - detik
    • md - milidetik
    • us - mikrodetik
    • ns - nanodetik

    Nilai negatif dan pecahan tidak diizinkan. Kolom Max retry duration hanya mendukung nilai h ,m, dan s. Baik Min backoff duration dan Max backoff duration mendukung kumpulan lengkap.

12. Secara opsional, untuk target HTTP dan App Engine HTTP, konfigurasikan batas waktu untuk percobaan tugas. Jika pengendali permintaan tidak merespons hingga batas waktu ini, permintaan akan dibatalkan dan upaya akan ditandai sebagai gagal. Cloud Scheduler mencoba ulang tugas sesuai dengan konfigurasi percobaan ulang.

13. Untuk membuat dan menyimpan lowongan, klik Buat.

    Sekarang tugas akan berjalan pada frekuensi yang ditentukan.

gcloud

Saat membuat tugas menggunakan gcloud CLI, Anda harus menggunakan perintah yang berbeda untuk setiap jenis target:

HTTP

Anda dapat mengirim permintaan ke endpoint HTTP atau HTTPS. Endpoint HTTP yang ditargetkan harus dapat diakses secara publik.

gcloud scheduler jobs create http JOB \
    --location=LOCATION \
    --schedule=SCHEDULE \
    --uri=URI

Ganti kode berikut:

• JOB: nama tugas yang harus unik dalam project. Perhatikan bahwa Anda tidak dapat menggunakan kembali nama tugas dalam sebuah project meskipun Anda menghapus tugas terkaitnya.

• LOCATION: lokasi untuk menjalankan tugas Anda.

• SCHEDULE: frekuensi, atau interval tugas, tempat tugas dijalankan, misalnya, every 3 hours. String yang Anda berikan di sini dapat berupa string apa pun yang kompatibel dengan unix-cron. Meskipun kami tidak lagi merekomendasikan penggunaannya, sintaksis cron App Engine lama masih didukung untuk tugas yang sudah ada.

  Untuk informasi selengkapnya, lihat Mengonfigurasi jadwal cron job.

• URI: URI endpoint yang sepenuhnya memenuhi syarat yang akan dihubungi tugas.

Parameter lain dijelaskan dalam referensi command line gcloud:

• (Opsional) Tentukan metode HTTP. Nilai defaultnya adalah POST.

• (Opsional) Tentukan data yang akan dikirim ke target. Data ini dikirim dalam isi permintaan sebagai byte saat metode HTTP POST atau PUT dipilih.

• Secara opsional, tetapkan nilai coba lagi, yang menentukan cara tugas App Engine dicoba ulang jika gagal. Dalam sebagian besar kasus, default-nya sudah cukup.

• Untuk membuat tugas Target HTTP yang memerlukan autentikasi, lihat Menggunakan Authentication dengan Target HTTP.

Contoh

gcloud scheduler jobs create http my-http-job \
    --schedule "0 1 * * 0" \
    --uri "http://myproject/my-url.com" \
    --http-method GET

Catatan: Saat menggunakan target HTTP, Cloud Scheduler mungkin melaporkan error permintaan gagal meskipun target berhasil ditampilkan. Hal ini dapat terjadi jika ada ketidakcocokan antara setelan waktu tunggu layanan target dan setelan Cloud Scheduler. Lihat deskripsi tugas untuk menetapkan kolom attempt_deadline.

Pub/Sub

Anda harus menggunakan topik Pub/Sub yang telah disiapkan di project. Cloud Scheduler akan memublikasikan pesan ke topik ini sebagai akun layanan Google API.

gcloud scheduler jobs create pubsub JOB \
    --location=LOCATION \
    --schedule=SCHEDULE \
    --topic=TOPIC

Ganti kode berikut:

• JOB: nama tugas yang harus unik dalam project. Perhatikan bahwa Anda tidak dapat menggunakan kembali nama tugas dalam sebuah project meskipun Anda menghapus tugas terkaitnya.

• LOCATION: lokasi untuk menjalankan tugas Anda.

• SCHEDULE: frekuensi, atau interval tugas, tempat tugas dijalankan, misalnya, every 3 hours. String yang Anda berikan di sini dapat berupa string apa pun yang kompatibel dengan unix-cron. Meskipun kami tidak lagi merekomendasikan penggunaannya, sintaksis cron App Engine lama masih didukung untuk tugas yang sudah ada.

  Untuk informasi selengkapnya, lihat Mengonfigurasi jadwal cron job.

• TOPIC: nama topik tempat tugas akan dipublikasikan. Gunakan flag --message-body atau --message-body-from-file untuk menentukan pesan yang akan dikirim ke topik. ID ini dikirim sebagai parameter data dalam pesan Pub/Sub. Untuk contoh cara melakukannya, lihat quickstart.

Parameter lain dijelaskan dalam referensi command line gcloud.

Contoh

gcloud scheduler jobs create pubsub myjob \
    --schedule "0 1 * * 0" \
    --topic cron-topic \
    --message-body "Hello"

HTTP App Engine

Target App Engine HTTP hanya tersedia untuk aplikasi App Engine yang terkait dengan project saat ini. Jika Anda ingin menggunakan aplikasi App Engine lain di luar project saat ini, pilih HTTP sebagai target, bukan App Engine HTTP. Aturan firewall target harus mengizinkan permintaan dari rentang IP 0.1.0.2/32.

Endpoint App Engine dapat diamankan dengan login: admin pada elemen handlers dalam file app.yaml.

gcloud scheduler jobs create app-engine \
    --JOB=JOB \
    --location=LOCATION \
    --schedule=SCHEDULE

Ganti kode berikut:

• JOB: nama tugas yang harus unik dalam project. Perhatikan bahwa Anda tidak dapat menggunakan kembali nama tugas dalam sebuah project meskipun Anda menghapus tugas terkaitnya.

• LOCATION: lokasi untuk menjalankan tugas Anda. Lokasi ini harus sama dengan lokasi aplikasi App Engine Anda.

• SCHEDULE: frekuensi, atau interval tugas, tempat tugas akan dijalankan, misalnya, every 3 hours. String yang Anda berikan di sini dapat berupa string apa pun yang kompatibel dengan unix-cron. Meskipun kami tidak lagi merekomendasikan penggunaannya, sintaksis cron App Engine lama masih didukung untuk tugas yang sudah ada.

  Untuk informasi selengkapnya, lihat Mengonfigurasi jadwal cron job.

Parameter lain dijelaskan dalam referensi command line gcloud:

• Tentukan URL relatif endpoint App Engine yang akan dihubungi oleh tugas. Jika Anda menggunakan nilai default /, tugas akan menggunakan PROJECT-ID.appspot.com, dengan PROJECT-ID yang merupakan project ID Anda saat ini.

• Tentukan nama layanan App Engine yang menjalankan pengendali untuk tugas Cloud Scheduler. Jika dihilangkan, layanan default diasumsikan. Jika ingin menyetelnya, Anda dapat menemukan nama layanannya di Google Cloud Console.

• Atau, tetapkan metode HTTP yang ingin Anda gunakan saat tugas dieksekusi. Nilai defaultnya adalah POST.

• (Opsional) Tentukan versi. Jika tidak disetel, versi yang saat ini ditayangkan akan digunakan. Anda dapat menemukan versi yang tersedia di Google Cloud Console.

• (Opsional) Tentukan instance. Jika tidak disetel, instance apa pun yang tersedia dapat digunakan. Anda dapat menemukan versi yang tersedia di Google Cloud Console.

• (Opsional) Tentukan data yang akan dikirim ke target. Data ini dikirim dalam isi permintaan sebagai byte saat metode HTTP POST atau PUT dipilih.

• Secara opsional, tetapkan nilai coba lagi, yang menentukan cara tugas App Engine dicoba ulang jika gagal. Dalam sebagian besar kasus, defaultnya sudah cukup.

Contoh

gcloud scheduler jobs create app-engine my-appengine-job \
    --schedule "0 1 * * 0" \
    --relative-url "/cron-handler"

Catatan: Jika Anda tidak menggunakan layanan default, URL target yang ditampilkan ke jendela terminal akan berbentuk https://SERVICE-dot-PROJECT-ID.r.appspot.com/. URL yang sama yang ditampilkan di UI Google Cloud Console adalah dalam bentuk SERVICE.PROJECT-ID.r.appspot.com/*. Kedua formulir tersebut setara.

Mengedit tugas

Anda dapat mengedit konfigurasi tugas.

Konsol

1. Di konsol Google Cloud, buka Cloud Scheduler.
   

   Buka Cloud Scheduler

2. Pilih tugas yang akan diedit.

3. Klik Edit.

4. Ikuti langkah-langkah untuk menentukan jadwal, mengonfigurasi eksekusi, dan mengonfigurasi setelan opsional saat membuat tugas.

gcloud

Saat mengedit tugas menggunakan gcloud CLI, Anda menggunakan perintah yang berbeda untuk setiap jenis target:

HTTP

Anda dapat mengirim permintaan ke endpoint HTTP atau HTTPS. Endpoint HTTP yang ditargetkan harus dapat diakses secara publik.

gcloud scheduler jobs update http JOB \
    --location=LOCATION \
    --schedule=SCHEDULE \
    --uri=URI

Ganti kode berikut:

• JOB: nama tugas yang harus unik dalam project. Perhatikan bahwa Anda tidak dapat menggunakan kembali nama tugas dalam sebuah project meskipun Anda menghapus tugas terkaitnya.

• LOCATION: lokasi tempat tugas Anda dijalankan. Jika lokasi tidak ditentukan, gcloud CLI akan menggunakan lokasi default Anda. Jika pekerjaan yang ingin Anda edit berada di lokasi lain, Anda harus menentukan lokasi selain NAME agar tugas Anda dapat diidentifikasi. Anda tidak dapat memperbarui lokasi pekerjaan.

• SCHEDULE: frekuensi, atau interval tugas, tempat tugas dijalankan, misalnya, every 3 hours. String yang Anda berikan di sini dapat berupa string apa pun yang kompatibel dengan unix-cron. Meskipun kami tidak lagi merekomendasikan penggunaannya, sintaksis cron App Engine lama masih didukung untuk tugas yang sudah ada.

  Untuk informasi selengkapnya, lihat Mengonfigurasi jadwal cron job.

• URI: URI endpoint yang sepenuhnya memenuhi syarat yang akan dihubungi tugas.

Parameter lain dijelaskan dalam referensi command line gcloud.

Contoh

gcloud scheduler jobs update http my-http-job \
    --schedule "0 1 * * 0" \
    --uri "http://myproject/my-url.com" \
    --http-method GET

Catatan: Saat menggunakan target HTTP, Cloud Scheduler mungkin melaporkan error permintaan gagal meskipun target berhasil ditampilkan. Hal ini dapat terjadi jika ada ketidakcocokan antara setelan waktu tunggu layanan target dan setelan Cloud Scheduler. Lihat deskripsi tugas untuk menetapkan kolom attempt_deadline.

Pub/Sub

Anda harus menggunakan topik Pub/Sub yang telah disiapkan di project. Cloud Scheduler akan memublikasikan pesan ke topik ini sebagai akun layanan Google API.

gcloud scheduler jobs update pubsub JOB \
    --location=LOCATION \
    --schedule=SCHEDULE \
    --topic=TOPIC

Ganti kode berikut:

• JOB: nama tugas yang harus unik dalam project. Perhatikan bahwa Anda tidak dapat menggunakan kembali nama tugas dalam sebuah project meskipun Anda menghapus tugas terkaitnya.

• LOCATION: lokasi tempat tugas Anda dijalankan. Jika lokasi tidak ditentukan, gcloud CLI akan menggunakan lokasi default Anda. Jika pekerjaan yang ingin Anda edit berada di lokasi lain, Anda harus menentukan lokasi selain NAME agar tugas Anda dapat diidentifikasi. Anda tidak dapat memperbarui lokasi pekerjaan.

• SCHEDULE: frekuensi, atau interval tugas, tempat tugas akan dijalankan, misalnya, every 3 hours. String yang Anda berikan di sini dapat berupa string apa pun yang kompatibel dengan unix-cron. Meskipun kami tidak lagi merekomendasikan penggunaannya, sintaksis cron App Engine lama masih didukung untuk tugas yang sudah ada.

  Untuk informasi selengkapnya, lihat Mengonfigurasi jadwal cron job.

• TOPIC: nama topik tempat tugas akan dipublikasikan. Gunakan tanda --message-body atau --message-body-from-file untuk menentukan pesan yang akan dikirim ke topik. ID ini dikirim sebagai parameter data dalam pesan Pub/Sub. Untuk contoh cara melakukannya, lihat quickstart.

Parameter lain dijelaskan dalam referensi command line gcloud.

Contoh

gcloud scheduler jobs update pubsub myjob \
    --schedule "0 1 * * 0" \
    --topic cron-topic --message-body "Hello"

HTTP App Engine

Target App Engine HTTP hanya tersedia untuk aplikasi App Engine yang terkait dengan project saat ini. Jika Anda ingin menggunakan aplikasi App Engine lain di luar project saat ini, pilih HTTP sebagai target, bukan App Engine HTTP.

Endpoint App Engine dapat diamankan dengan login: admin pada elemen handlers dalam file app.yaml.

gcloud scheduler jobs update app-engine JOB \
    --location=LOCATION \
    --schedule=SCHEDULE

Ganti kode berikut:

• JOB: nama tugas yang harus unik dalam project. Perhatikan bahwa Anda tidak dapat menggunakan kembali nama tugas dalam sebuah project meskipun Anda menghapus tugas terkaitnya.

• LOCATION: lokasi tempat tugas Anda dijalankan (ini sama dengan lokasi aplikasi App Engine target Anda). Jika lokasi tidak ditentukan, gcloud CLI akan menggunakan lokasi default Anda. Jika pekerjaan yang ingin Anda edit berada di lokasi lain, Anda harus menentukan lokasi selain NAME agar tugas Anda dapat diidentifikasi. Anda tidak dapat memperbarui lokasi pekerjaan.

• SCHEDULE: frekuensi, atau interval tugas, tempat tugas akan dijalankan, misalnya, every 3 hours. String yang Anda berikan di sini dapat berupa string apa pun yang kompatibel dengan unix-cron. Meskipun kami tidak lagi merekomendasikan penggunaannya, sintaksis cron App Engine lama masih didukung untuk tugas yang sudah ada.

  Untuk informasi selengkapnya, lihat Mengonfigurasi jadwal cron job.

Parameter lain dijelaskan dalam referensi command line gcloud.

Contoh

gcloud scheduler jobs update app-engine my-appengine-job \
    --schedule "0 1 * * 0" \
    --relative-url "/cron-handler"

Catatan: Jika Anda tidak menggunakan layanan default, URL target yang ditampilkan ke jendela terminal akan berbentuk https://SERVICE-dot-PROJECT-ID.r.appspot.com/. URL yang sama yang ditampilkan di UI Google Cloud Console adalah dalam bentuk SERVICE.PROJECT-ID.r.appspot.com/*. Kedua formulir tersebut setara.

Menjeda tugas

Anda dapat menjeda eksekusi tugas.

Konsol

1. Di konsol Google Cloud, buka Cloud Scheduler.
   

   Buka Cloud Scheduler

2. Pilih tugas yang akan dijeda.

3. Klik Jeda.

gcloud

1. Buka jendela terminal di komputer tempat Anda menginstal gcloud CLI.

2. Jalankan perintah:

   gcloud scheduler jobs pause MY_JOB
   

   Ganti MY_JOB dengan nama tugas yang akan dijeda.

Saat lowongan dijeda, Anda juga dapat mengedit. Setelah mengedit tugas, tugas tetap dijeda sampai Anda melanjutkannya.

Melanjutkan tugas

Anda dapat melanjutkan eksekusi tugas yang dijeda.

Konsol

1. Di konsol Google Cloud, buka Cloud Scheduler.
   

   Buka Cloud Scheduler

2. Pilih pekerjaan untuk dilanjutkan.

   Tugas harus sudah dijeda.

3. Klik Lanjutkan.

gcloud

1. Buka jendela terminal di komputer tempat Anda menginstal gcloud CLI.

2. Jalankan perintah:

   gcloud scheduler jobs resume MY_JOB
   

   Ganti MY_JOB dengan nama tugas untuk dilanjutkan.

Menghapus tugas

Anda dapat menghapus tugas.

Konsol

1. Di konsol Google Cloud, buka Cloud Scheduler.
   

   Buka Cloud Scheduler

2. Pilih tugas yang akan dihapus.

3. Klik Delete.

gcloud

1. Buka jendela terminal di komputer tempat Anda menginstal gcloud CLI.

2. Jalankan perintah:

   gcloud scheduler jobs delete MY_JOB
   

   Ganti MY_JOB dengan nama tugas yang akan dihapus.