Tugas Call REST Endpoint memungkinkan Anda memanggil REST
API pihak ketiga dari integrasi Anda. Respons dari panggilan REST API akan tersedia untuk
Anda dalam variabel integrasi dan dapat digunakan dalam tugas hilir lainnya.
Sebelum memulai
Untuk terhubung ke endpoint autentikasi untuk panggilan REST API, pastikan Anda telah membuat
profil OAuth 2.0 atau melampirkan akun layanan yang dikelola pengguna ke integrasi Anda. Jika API Anda tidak memerlukan autentikasi, kolom Profil autentikasi di panel konfigurasi tugas dapat dibiarkan kosong. Untuk melihat daftar konfigurasi, lihat Properti konfigurasi.
Jika integrasi Anda telah mengonfigurasi profil OAuth 2.0 dan akun layanan yang dikelola pengguna, maka secara default profil OAuth 2.0 digunakan untuk autentikasi. Jika profil OAuth 2.0 maupun akun layanan yang dikelola pengguna tidak dikonfigurasi, eksekusi akan gagal.
Jika integrasi Anda memiliki akun layanan yang terlampir, berdasarkan URL endpoint REST, berikan peran IAM yang diperlukan ke akun layanan tersebut. Misalnya, jika URL endpoint REST Anda memanggil layanan Cloud Storage, berikan peran IAM yang diperlukan untuk layanan Cloud Storage.
Halaman Integrasi akan muncul dan mencantumkan semua integrasi yang tersedia di project Google Cloud.
Pilih integrasi yang ada atau klik Buat integrasi untuk membuat integrasi baru.
Jika Anda membuat integrasi baru:
Masukkan nama dan deskripsi di panel Buat Integrasi.
Pilih region untuk integrasi.
Pilih akun layanan untuk integrasi. Anda dapat mengubah atau memperbarui detail akun layanan integrasi kapan saja dari panel infoRingkasan integrasi di toolbar integrasi.
Klik Buat. Integrasi yang baru dibuat akan terbuka di editor integrasi.
Di menu navigasi editor integrasi, klik Tugas untuk melihat daftar tugas dan konektor yang tersedia.
Klik dan tempatkan elemen Call REST Endpoint di editor integrasi.
Klik elemen Call REST Endpoint di perancang untuk melihat panel konfigurasi
tugas Call REST Endpoint.
Konfigurasi kolom yang ditampilkan menggunakan properti konfigurasi tugas seperti yang dijelaskan dalam tabel di bawah.
Perubahan pada properti akan disimpan secara otomatis.
Properti konfigurasi
Tabel berikut menjelaskan properti konfigurasi tugas Call REST Endpoint.
Anda dapat memilih salah satu metode HTTP berikut:
HAPUS
DAPATKAN
KEPALA
PATCH
POST
PUT
Parameter string kueri URL
Kunci string kueri : String
Nilai: String
Parameter kueri yang diperlukan untuk panggilan REST API.
Parameter kueri berbentuk pasangan nilai kunci dengan kunci adalah nama kunci
dan nilai adalah nilai kunci yang sesuai. Anda dapat memasukkan lebih dari satu pasangan nilai kunci dengan mengklik ikon plus.
Header HTTP
Kunci header HTTP: String
Nilai: String
Header HTTP yang diperlukan untuk panggilan REST API.
Header HTTP berbentuk key-value pair dengan key adalah nama key dan
value adalah nilai key yang sesuai. Anda dapat memasukkan lebih dari satu pasangan nilai kunci
dengan mengklik ikon plus.
Mengikuti pengalihan
Boolean
Mengikuti pengalihan URL.
Anda dapat memilih salah satu nilai:
Benar : Memanggil URL yang dialihkan jika URL dasar Endpoint
diteruskan ke URL lain.
Salah (False): Tidak memanggil URL yang dialihkan jika URL dasar Endpoint
diteruskan ke URL lain.
Tugas akan gagal karena error HTTP
Boolean
Strategi penanganan pengecualian saat panggilan REST API gagal.
Call REST Endpoint akan gagal jika kode respons HTTP adalah 4xx atau 5xx. Untuk mengetahui daftar kode error, lihat Kode error. Untuk kode respons HTTP lainnya, tampilkan kode error dan pesan error dalam respons.
Anda dapat memilih salah satu nilai:
Benar : Menampilkan pengecualian.
Salah: Tidak memberikan pengecualian. Namun, menampilkan
kode error dan pesan error dalam respons.
Header respons (<Nama tugas>)
String
Header respons yang tidak dikompresi dari respons REST API.
Isi respons (<Nama tugas>)
String
Isi respons yang tidak dikompresi dari respons REST API.
Status respons (<Nama tugas>)
String
Kode respons HTTP dan teks kode yang sesuai dari respons REST API.
Praktik terbaik
Untuk mengetahui informasi tentang batas penggunaan yang berlaku untuk tugas Call REST Endpoint, lihat Batas penggunaan.
Strategi penanganan error
Strategi penanganan error untuk tugas menentukan tindakan yang harus dilakukan jika tugas gagal karena error sementara. Untuk mengetahui informasi tentang cara menggunakan strategi penanganan error, dan untuk mengetahui berbagai jenis strategi penanganan error, lihat Strategi penanganan error.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-09-03 UTC."],[[["\u003cp\u003eThe \u003cstrong\u003eCall REST Endpoint\u003c/strong\u003e task enables integrations to interact with any third-party REST API, with the response data being accessible for use in subsequent tasks.\u003c/p\u003e\n"],["\u003cp\u003eThis task is restricted to calling endpoints accessible over the public internet and cannot connect to resources within private networks like VPCs.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication for REST API calls requires either a pre-configured OAuth 2.0 profile or an attached user-managed service account, however, authentication isn't needed if it's not required by the API.\u003c/p\u003e\n"],["\u003cp\u003eThe task supports various HTTP methods (DELETE, GET, HEAD, PATCH, POST, PUT) and allows for the configuration of URL query string parameters and HTTP headers.\u003c/p\u003e\n"],["\u003cp\u003eThe task has a response limit of 50 MB, and you can manage error handling, with the ability to throw exceptions or return error codes and messages based on HTTP status codes.\u003c/p\u003e\n"]]],[],null,["# Call REST Endpoint task\n\nSee the [supported connectors](/integration-connectors/docs/connector-reference-overview) for Application Integration.\n\nCall REST Endpoint task\n=======================\n\nThe **Call REST Endpoint** task lets you call any third-party REST\nAPI from your integration. The response from the REST API call will be available to\nyou in an integration variable and can be used in other down-stream tasks.\n| **Note:**\n|\n| - The network configuration of the **Call REST Endpoint** task allows it to call endpoints only available over the public internet. Hence, the task can't connect to hosts or IPs that reside only within a private network such as a VPC, even if that VPC is peered with your other Google Cloud services such as Apigee X.\n| - This task can process a maximum of 50 MB of REST response.\n\nBefore you begin\n----------------\n\n- To connect to an authentication endpoint for the REST API call, ensure that you have either [created\n an OAuth 2.0 profile](/application-integration/docs/configuring-auth-profile#createAuthProfile) or [attached a user-managed service account](/application-integration/docs/access-control#add-service-account) to your integration. If your API does not require authentication, then the **Authentication profile** field in the task configuration pane can be left empty. To see a list of configurations, see [Configuration properties](#params).\n\n If your integration has both OAuth 2.0 profile and a user-managed service account configured, then by default the OAuth 2.0 profile is used for authentication. If neither OAuth 2.0 profile nor user-managed service account is configured, then the execution fails.\n- If your integration has a service account attached, then based on the REST endpoint URL, grant the required IAM role to that service account. For example, if your REST endpoint URL calls a Cloud Storage service, then grant the required IAM role for the Cloud Storage service. For information about granting roles to a service account, see [Manage access to service accounts](/iam/docs/manage-access-service-accounts).\n\n- Ensure that [VPC Service Controls](/application-integration/docs/vpc-service-controls) is **NOT** setup for Application Integration in your Google Cloud project. **Warning:** **Cloud Function** does not function or stops functioning if [VPC Service Controls](/application-integration/docs/vpc-service-controls) is setup for Application Integration in your Google Cloud project.\n\nConfigure the Call REST Endpoint task\n-------------------------------------\n\nTo configure the **Call REST Endpoint** task:\n\n1. In the Google Cloud console, go to the **Application Integration** page.\n\n [Go to Application Integration](https://console.cloud.google.com/integrations)\n2. In the navigation menu, click **Integrations** .\n\n\n The **Integrations** page appears listing all the integrations available in the Google Cloud project.\n3. Select an existing integration or click **Create integration** to create a new one.\n\n\n If you are creating a new integration:\n 1. Enter a name and description in the **Create Integration** pane.\n 2. Select a region for the integration. **Note:** The **Regions** dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, click **Enable Region** . See [Enable new region](/application-integration/docs/enable-new-region) for more information.\n 3. Select a service account for the integration. You can change or update the service account details of an integration any time from the info **Integration summary** pane in the integration toolbar. **Note:** The option to select a service account is displayed only if you have enabled integration governance for the selected region.\n 4. Click **Create** . The newly created integration opens in the *integration editor*.\n\n\n4. In the *integration editor* navigation bar, click **Tasks** to view the list of available tasks and connectors.\n5. Click and place the **Call REST Endpoint** element in the integration editor.\n6. Click the **Call REST Endpoint** element on the designer to view the **Call REST Endpoint** task configuration pane.\n7. Configure the displayed fields using the [configuration properties](#params) of the task as detailed in the table below.\n\n\n Changes to the properties are saved automatically.\n | **Note:** If you update the authentication profile for a **Call REST Endpoint** task, and test the integration without publishing the changes, the integration uses the old authentication profile. To ensure that the integration uses the updated authentication profile, you must [publish the integration](https://cloud.google.com/application-integration/docs/test-publish-integrations) before testing.\n\nConfiguration properties\n------------------------\n\n\nThe following table describes the configuration properties of the **Call REST Endpoint** task.\n\nBest practices\n--------------\n\nFor information about the usage limits that apply to the **Call REST Endpoint** task, see [Usage limits](/application-integration/docs/quotas#usage-limits).\n\nError handling strategy\n-----------------------\n\n\nAn error handling strategy for a task specifies the action to take if the task fails due to a [temporary error](/application-integration/docs/error-handling). For information about how to use an error handling strategy, and to know about the different types of error handling strategies, see [Error handling strategies](/application-integration/docs/error-handling-strategy).\n\nTo learn how to handle retry strategies for `4xx` or `5xx` errors, see the [How to retry Rest Caller Task based on Response Status](https://www.googlecloudcommunity.com/gc/Integration-Services/How-to-retry-Rest-Caller-Task-based-on-Response-Status/m-p/618079) blog.\n\nQuotas and limits\n-----------------\n\nFor information about quotas and limits, see [Quotas and limits](/application-integration/docs/quotas).\n\nWhat's next\n-----------\n\n- Learn about [all tasks and triggers](/application-integration/docs/all-triggers-tasks).\n- Learn how to [test and publish an integration](/application-integration/docs/test-publish-integrations).\n- Learn about [error handling](/application-integration/docs/error-handling-strategy).\n- Learn about [integration execution logs](/application-integration/docs/introduction-logs)."]]
