Menggunakan Datastream API

Datastream menyediakan REST API untuk mengelola konfigurasi konektivitas pribadi, profil koneksi, dan aliran data secara terprogram. REST API ditentukan oleh resource yang terkait dengan pembuatan dan pengelolaan konfigurasi konektivitas pribadi, profil koneksi, dan aliran data. Untuk mengetahui detail tentang semua resource dan metodenya, lihat Referensi Datastream API.

Datastream API versi v1 kini tersedia secara umum. Jika Anda menggunakan API ini versi v1alpha1, sebaiknya migrasikan ke versi v1. Versi v1alpha1 tidak akan digunakan lagi pada akhir tahun 2022.

Saat mengirim permintaan langsung ke Datastream REST API, Anda harus membuat formulir permintaan yang benar, memberikan otorisasi permintaan sebagai pengguna yang diautentikasi, dan memproses respons yang ditampilkan. Banyak tugas dalam dokumentasi ini memberikan contoh API menggunakan cURL.

Untuk contoh penggunaan API lainnya, lihat halaman untuk permintaan di Referensi Datastream API. Setiap halaman memiliki contoh yang memanggil API dalam beberapa bahasa pemrograman, serta Penjelajah khusus permintaan untuk membantu Anda melihat apa yang masuk ke dalam permintaan yang dibuat dengan baik dan apa yang akan Anda dapatkan dalam respons.

Anda juga menggunakan Datastream API, secara tidak langsung, saat menggunakan salah satu cara berikut untuk mengelola instance:

• Google Cloud CLI: Antarmuka command line (CLI) yang dapat Anda gunakan untuk menggunakan instance.

• Konsol Google Cloud: Antarmuka web grafis.

Keuntungan menggunakan metode ini, terutama konsol Google Cloud, adalah metode ini dapat sangat menyederhanakan pengelolaan konfigurasi konektivitas pribadi, profil koneksi, dan streaming (bergantung pada kasus penggunaan Anda). Jika Anda baru memulai dengan Datastream, sebaiknya mulai dengan salah satu alat ini terlebih dahulu sebelum menggunakan REST API secara langsung.

Mengaktifkan API

Untuk menggunakan Datastream API, Anda harus mengaktifkannya:

Konsol

1. Aktifkan Datastream API.
2. Pilih project Anda.
3. Pilih Lanjutkan.

gcloud

1. Masukkan kode berikut untuk menampilkan project ID untuk project Google CloudAnda:

   gcloud projects list

2. Setel project default Anda:

   gcloud config set project YOUR_PROJECT_ID

3. Aktifkan Datastream API:

   gcloud services enable datastream.googleapis.com

Izin

Anda harus memiliki izin yang diperlukan untuk menggunakan Datastream API. Izin ini mencakup:

• Admin Datastream: Dengan izin ini, pengguna akan mendapatkan akses ke semua resource Datastream yang digunakan untuk mengelola konfigurasi konektivitas pribadi, profil koneksi, dan aliran data.
• Pelihat Datastream: Dengan izin ini, pengguna memiliki akses hanya baca ke konfigurasi konektivitas pribadi, profil koneksi, dan streaming di Datastream.

Google Cloud menawarkan Identity and Access Management (IAM), yang memungkinkan Anda memberikan akses yang lebih terperinci ke resource Google Cloud tertentu dan mencegah akses yang tidak diinginkan ke resource lain. Anda dapat mendapatkan dan menetapkan izin untuk Datastream menggunakan Google Cloud Konsol, metode IAM API, atau Google Cloud SDK. Untuk mengetahui informasi selengkapnya, lihat Memberikan, mengubah, dan mencabut akses ke resource.

Contoh API

Anda dapat melihat contoh penggunaan Datastream API dengan cURL di halaman berikut dalam dokumentasi Datastream:

• Mengelola konfigurasi konektivitas pribadi
• Mengelola profil koneksi
• Mengelola streaming

Memberikan data JSON dari file

Saat menggunakan API dengan cURL, Anda memberikan nilai properti menggunakan command line. Jika Anda menggunakan nilai sensitif seperti sandi atau kunci keamanan, menyediakan nilai tersebut di command line akan menimbulkan risiko keamanan. Untuk meningkatkan keamanan, Anda dapat membuat file yang berisi data JSON untuk panggilan API, dan memberikan jalur ke file di command line.

Untuk memberikan data JSON ke panggilan cURL API dari file:

1. Buat file yang berisi semua yang diapit tanda petik tunggal untuk kolom --data.

   Sertakan tanda kurung kurawal, tetapi jangan sertakan tanda kutip tunggal.

2. Di command line, berikan jalur ke file, yang didahului dengan karakter @, sebagai parameter --data:

   --data @<path-to-file>/<filename>

   Misalnya, untuk membuat profil koneksi untuk sumber MySQL, Anda dapat membuat file bernama request.json dengan konten berikut:

   {
     "displayName": "my MySQL connection profile",
     "mysql": {
       "host": "10.11.12.13",
       "port": 3306,
       "username": "myusername",
       "password": "mypassword"
     }
   }
   

   Kemudian, Anda akan menggunakan perintah cURL berikut di command line:

   curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
        --header 'Content-Type: application/json' \
        --data @./request.json \
        -X POST \
        https://datastream.googleapis.com/v1/projects/myProject/locations/myLocation/connectionProfiles?connectionProfileId=myMySQLconnectionprofile

Menggunakan panggilan API yang berjalan lama

Beberapa panggilan API, seperti pembuatan objek, dapat memerlukan waktu beberapa saat untuk diselesaikan. Karena API bersifat asinkron, panggilan akan segera ditampilkan, meskipun operasi masih berlangsung. Jika panggilan API berikutnya menggunakan objek yang baru dibuat, Anda harus menunggu operasi pertama selesai sebelum melanjutkan.

Anda dapat menggunakan Datastream API untuk mengelola operasi. Hal ini mencakup:

• Menampilkan detail tentang operasi
• Mencantumkan operasi untuk suatu wilayah
• Menghapus operasi

Datastream dan Layanan Penemuan Google API

Layanan Penemuan Google API adalah layanan yang dapat Anda gunakan untuk menemukan Google API. Misalnya, saat menggunakan alat Google APIs Explorer , Anda menggunakan Layanan Penemuan.

Di Layanan Penemuan, Datastream direpresentasikan sebagai "datastream" (misalnya: https://datastream.googleapis.com/$discovery/rest?version=v1).