Pengendali Cloud Tasks dapat dijalankan di endpoint HTTP mana pun dengan alamat IP eksternal seperti GKE, Compute Engine, atau bahkan server web lokal. Tugas Anda dapat dijalankan di salah satu layanan ini dengan cara yang dapat diandalkan dan dikonfigurasi.
Halaman ini menunjukkan cara membuat tugas target HTTP dasar secara terprogram dan menempatkannya di antrean Cloud Tasks.
Untuk tugas yang memiliki target HTTP (bukan target App Engine eksplisit, yang kurang umum), ada dua cara untuk membuat tugas:
Metode
BufferTask
: Gunakan metode ini jika antrean Anda disiapkan untuk menampung tugas di depan layanan. Antrean harus memiliki pemilihan rute tingkat antrean. Untuk sebagian besar kasus penggunaan, ini adalah pendekatan terbaik. Pendekatan ini menggunakan metodeBufferTask
.Metode
CreateTask
: Metode ini lebih kompleks. Anda harus membuat objek tugas secara eksplisit. Gunakan metode ini jika tugas dalam antrean Anda memiliki konfigurasi pemilihan rute yang berbeda. Dalam hal ini, Anda menentukan pemilihan rute di level tugas dan tidak dapat menggunakan pemilihan rute tingkat antrean. Pendekatan ini menggunakan metodeCreateTask
.
Pembuatan tugas dasar (metode BufferTask
)
Bagian ini membahas pembuatan tugas dengan mengirim permintaan HTTP. Metode
yang Anda gunakan disebut BufferTask
.
Batasan
Metode BufferTask
tunduk pada batasan berikut:
Library klien: Metode
BufferTask
tidak didukung di library klien.RPC API: Metode
BufferTask
tidak didukung di RPC API.Pemilihan rute tingkat tugas: Metode ini tidak mendukung pemilihan rute tingkat tugas. Karena tidak ada tempat untuk menambahkan informasi pemilihan rute saat membuat tugas dengan cara ini, Anda harus menggunakan pemilihan rute tingkat antrean (jika tidak, tugas tidak akan memiliki informasi pemilihan rute). Jika antrean Anda belum menggunakan pemilihan rute tingkat antrean, lihat Mengonfigurasi pemilihan rute tingkat antrean untuk tugas HTTP.
Memanggil metode BufferTask
Contoh berikut menunjukkan cara membuat tugas dengan mengirim permintaan POST
HTTP ke endpoint buffer
Cloud Tasks API.
curl
Cuplikan kode berikut menunjukkan contoh pembuatan tugas menggunakan
metode BufferTask
menggunakan curl
:
curl -X HTTP_METHOD\ "https://cloudtasks.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION/queues/QUEUE_ID/tasks:buffer" \
Ganti kode berikut:
HTTP_METHOD
: metode HTTP untuk permintaan Anda; misalnya,GET
atauPOST
.PROJECT_ID
: ID project Google Cloud Anda. Anda bisa mendapatkannya dengan menjalankan perintah berikut di terminal:gcloud config get-value project
LOCATION
: lokasi antrean Anda.QUEUE_ID
: ID antrean Anda.
Python
Pembuatan tugas lanjutan (metode CreateTask
)
Bagian ini membahas cara membuat tugas dengan membuat objek tugas. Anda menggunakan
metode CreateTask
.
Saat membuat tugas menggunakan metode CreateTask
, Anda secara eksplisit membuat dan
menentukan objek tugas. Anda harus menentukan layanan dan pengendali yang memproses
tugas.
Secara opsional, Anda dapat meneruskan data khusus tugas ke pengendali. Anda juga dapat menyesuaikan konfigurasi untuk tugas, seperti menjadwalkan waktu pada masa mendatang saat tugas harus dijalankan atau membatasi frekuensi percobaan ulang tugas yang diinginkan jika gagal (lihat Konfigurasi lanjutan).
Contoh berikut memanggil metode CreateTask
untuk membuat tugas menggunakan library klien Cloud Tasks.
C#
Go
Java
Perhatikan file pom.xml
:
Node.js
Perhatikan file package.json
:
PHP
Perhatikan file composer.json
:
Python
Perhatikan file requirements.txt
:
Ruby
Menyiapkan akun layanan untuk autentikasi pengendali target HTTP
Cloud Tasks dapat memanggil pengendali target HTTP yang memerlukan autentikasi jika Anda memiliki akun layanan dengan kredensial yang sesuai untuk mengakses pengendali.
Jika Anda memiliki akun layanan saat ini yang ingin digunakan, Anda dapat melakukannya. Cukup berikan peran yang sesuai. Petunjuk ini membahas cara membuat akun layanan baru khusus untuk fungsi ini. Akun layanan yang ada atau baru yang digunakan untuk autentikasi Cloud Tasks harus berada dalam project yang sama dengan antrean Cloud Tasks Anda.
Di Konsol Google Cloud, buka halaman Service accounts.
Jika perlu, pilih project yang sesuai.
Klik Create service account.
Di bagian Detail akun layanan, beri nama akun. Konsol akan membuat nama akun email terkait untuk akun tersebut. Ini adalah cara Anda mereferensikan akun. Anda juga dapat menambahkan deskripsi tujuan akun. Klik Buat dan lanjutkan.
Di bagian Berikan akses project ke akun layanan ini, klik Pilih peran. Telusuri dan pilih Cloud Tasks Enqueuer. Peran ini memberi akun layanan izin untuk menambahkan tugas ke antrean.
Klik + Tambahkan peran lain.
Klik Pilih peran. Telusuri dan pilih Service Account User. Peran ini memungkinkan akun layanan mengizinkan antrean membuat token atas namanya menggunakan kredensial akun layanan.
Jika pengendali Anda adalah bagian dari Google Cloud, berikan peran yang terkait dengan akses ke layanan tempat pengendali Anda berjalan kepada akun layanan. Setiap layanan dalam Google Cloud memerlukan peran yang berbeda. Misalnya, untuk mengakses pengendali di Cloud Run, berikan peran Cloud Run Invoker. Anda dapat menggunakan akun layanan yang baru saja dibuat atau akun layanan lainnya di project Anda.
Klik Selesai untuk menyelesaikan pembuatan akun layanan.
Cloud Tasks itu sendiri harus memiliki akun layanan sendiri yang memiliki peran Cloud Tasks Service Agent
yang diberikan. Hal ini agar dapat menghasilkan token header berdasarkan kredensial yang terkait dengan akun layanan Cloud Tasks untuk mengautentikasi dengan target pengendali Anda. Akun layanan Cloud Tasks dengan peran ini yang diberikan akan otomatis dibuat saat Anda mengaktifkan Cloud Tasks API, kecuali Anda mengaktifkannya sebelum 19 Maret 2019. Jika demikian, Anda harus menambahkan peran secara manual.
Menggunakan tugas target HTTP dengan token autentikasi
Untuk mengautentikasi antara Cloud Tasks dan pengendali target HTTP yang memerlukan autentikasi tersebut, Cloud Tasks akan membuat token header. Token ini didasarkan pada kredensial di akun layanan Cloud Tasks Enqueuer
, yang diidentifikasi oleh alamat emailnya. Akun layanan yang digunakan untuk autentikasi harus merupakan bagian dari project yang sama dengan antrean Cloud Tasks Anda. Permintaan, dengan
token header, dikirim dari antrean ke pengendali melalui HTTPS. Anda dapat menggunakan
token ID
atau token akses.
Token ID umumnya harus digunakan untuk pengendali apa pun yang berjalan di Google Cloud, misalnya, pada fungsi Cloud Run atau Cloud Run. Pengecualian utamanya adalah
untuk Google API yang dihosting di *.googleapis.com
: API ini memerlukan token akses.
Anda dapat mengonfigurasi autentikasi di tingkat antrean, atau di tingkat tugas. Untuk mengonfigurasi autentikasi di tingkat antrean, lihat Membuat antrean Cloud Tasks. Jika autentikasi dikonfigurasi di tingkat antrean, konfigurasi ini akan mengganti konfigurasi di tingkat tugas. Untuk mengonfigurasi autentikasi di tingkat tugas, tentukan token ID (OIDC) atau token akses (OAuth) di tugas itu sendiri.
Metode BufferTask
Contoh berikut menggunakan kredensial default aplikasi untuk melakukan autentikasi saat menggunakan metode BufferTask
untuk membuat tugas.
curl
curl -X HTTP_METHOD\ "https://cloudtasks.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION/queues/QUEUE_ID/tasks:buffer" \ -H "Authorization: Bearer ACCESS_TOKEN"
Ganti kode berikut:
HTTP_METHOD
: metode HTTP untuk permintaan Anda; misalnya,GET
atauPOST
.PROJECT_ID
: ID project Google Cloud Anda. Anda bisa mendapatkannya dengan menjalankan perintah berikut di terminal:gcloud config get-value project
LOCATION
: lokasi antrean Anda.QUEUE_ID
: ID antrean Anda.ACCESS_TOKEN
: token akses Anda. Anda bisa mendapatkannya dengan menjalankan perintah berikut di terminal:gcloud auth application-default login
gcloud auth application-default print-access-token
Python
Dalam contoh kode berikut, berikan nilai token autentikasi Anda.
Metode CreateTask
Contoh berikut menggunakan metode CreateTask
dengan library klien Cloud Tasks untuk membuat tugas yang juga menyertakan pembuatan token header. Token ID digunakan dalam contoh.
Untuk menggunakan token akses, ganti parameter OIDC dengan parameter OAuth yang sesuai bahasa
dalam membuat permintaan.
Go
Java
Perhatikan file pom.xml
:
Node.js
Perhatikan file package.json
:
Python
Perhatikan file requirements.txt
:
Menyediakan pengendali tugas target HTTP Anda sendiri
Pengendali tugas Target HTTP sangat mirip dengan pengendali tugas App Engine, dengan pengecualian berikut:
- Waktu tunggu: untuk semua pengendali tugas target HTTP, waktu tunggu default-nya adalah 10 menit, dengan maksimum 30 menit.
- Logika autentikasi: jika Anda menulis kode sendiri di layanan yang ditargetkan untuk memvalidasi token, Anda harus menggunakan token ID. Untuk mengetahui informasi selengkapnya tentang hal ini, lihat OpenID Connect, terutama Memvalidasi token ID.
Header: permintaan target HTTP memiliki header yang ditetapkan oleh antrean, yang berisi informasi khusus tugas yang dapat digunakan pengendali. Header ini mirip dengan, tetapi tidak identik dengan, header yang ditetapkan pada permintaan tugas App Engine. Header ini hanya memberikan informasi. ID ini tidak boleh digunakan sebagai sumber identitas.
Jika ada header ini dalam permintaan pengguna eksternal ke aplikasi Anda, header tersebut akan diganti dengan header internal. Satu-satunya pengecualian adalah untuk permintaan dari administrator aplikasi yang login, yang diizinkan menyetel header untuk tujuan pengujian.
Permintaan target HTTP selalu berisi header berikut:
Header Deskripsi X-CloudTasks-QueueName
Nama antrean. X-CloudTasks-TaskName
Nama "pendek" tugas, atau, jika tidak ada nama yang ditentukan saat pembuatan, ID unik yang dihasilkan sistem. Ini adalah nilai my-task-id
dalam nama tugas lengkap, yaitu, task_name =projects/my-project-id/locations/my-location/queues/my-queue-id/tasks/my-task-id
.X-CloudTasks-TaskRetryCount
Frekuensi percobaan ulang tugas ini. Untuk upaya pertama, nilainya adalah 0
. Jumlah ini mencakup upaya saat tugas gagal karena kode error 5XX dan tidak pernah mencapai fase eksekusi.X-CloudTasks-TaskExecutionCount
Total frekuensi tugas menerima respons dari pengendali. Karena Cloud Tasks menghapus tugas setelah respons berhasil diterima, semua respons pengendali sebelumnya gagal. Jumlah ini tidak mencakup kegagalan karena kode error 5XX. X-CloudTasks-TaskETA
Waktu penjadwalan tugas, ditentukan dalam detik sejak 1 Januari 1970. Selain itu, permintaan dari Cloud Tasks mungkin berisi header berikut:
Header Deskripsi X-CloudTasks-TaskPreviousResponse
Kode respons HTTP dari percobaan ulang sebelumnya. X-CloudTasks-TaskRetryReason
Alasan percobaan ulang tugas.
Menambahkan peran Agen Layanan Cloud Tasks ke akun layanan Cloud Tasks secara manual
Tindakan ini hanya diperlukan jika Anda mengaktifkan Cloud Tasks API sebelum 19 Maret 2019.
Konsol
- Temukan nomor project untuk project Anda di Halaman Project Settings Google Cloud.
- Salin nomor tersebut.
- Buka Halaman Konsol Admin IAM.
- Klik Grant access. Layar Berikan akses akan terbuka.
Di bagian Tambahkan akun utama, tambahkan alamat email dengan format:
service-PROJECT_NUMBER@gcp-sa-cloudtasks.
Ganti PROJECT_NUMBER dengan nomor project Google Cloud Anda.
Di bagian Assign roles, telusuri dan pilih Cloud Tasks Service Agent.
Klik Simpan.
gcloud
Temukan nomor project Anda:
gcloud projects describe PROJECT_ID --format='table(projectNumber)'
Ganti PROJECT_ID dengan project ID Anda.
Salin nomor tersebut.
Berikan peran
Cloud Tasks Service Agent
ke akun layanan Cloud Tasks, menggunakan nomor project yang Anda salin:gcloud projects add-iam-policy-binding PROJECT_ID --member serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudtasks. --role roles/cloudtasks.serviceAgent
Ganti kode berikut:
PROJECT_ID
: Project ID Google Cloud Anda.PROJECT_NUMBER
: nomor project Google Cloud Anda.
Konfigurasi lanjutan
Ada sejumlah atribut yang dapat Anda konfigurasi dalam tugas. Untuk daftar lengkap, lihat definisi resource tugas.
Contoh atribut yang dapat Anda sesuaikan:
- Penamaan: Jika Anda memilih untuk menentukan nama untuk tugas, Cloud Tasks dapat menggunakan nama tersebut untuk memastikan penghapusan duplikat tugas, meskipun pemrosesan yang diperlukan untuk hal ini dapat meningkatkan latensi.
- Penjadwalan: Anda dapat menjadwalkan tugas pada waktu mendatang. Hanya didukung
untuk
CreateTask
(tidak didukung untukBufferTask
) - Konfigurasi percobaan ulang: Konfigurasikan perilaku percobaan ulang untuk tugas jika tugas gagal. Hanya didukung untuk
CreateTask
(tidak didukung untukBufferTask
)
Langkah selanjutnya
- Pelajari tugas target HTTP lebih lanjut di referensi RPC API.
- Pelajari tugas target HTTP lebih lanjut di referensi REST API.