Menggunakan Datastream API

Ringkasan

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

Saat mengirim permintaan langsung ke Datastream REST API, Anda harus membuat bentuk permintaan yang benar, mengizinkan permintaan sebagai pengguna terautentikasi, dan memproses respons apa pun yang ditampilkan. Banyak tugas dalam dokumentasi ini menyediakan contoh API menggunakan cURL.

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

Anda juga menggunakan Datastream API secara tidak langsung saat menggunakan salah satu cara pengelolaan instance berikut:

Google Cloud CLI: Antarmuka command line (CLI) yang dapat digunakan untuk bekerja dengan instance Anda.
Konsol Google Cloud: Antarmuka web grafis.

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

Mengaktifkan API

Untuk menggunakan Datastream API, Anda harus mengaktifkannya:

Konsol

Aktifkan Datastream API.
Pilih project Anda.
Pilih Lanjutkan.

gcloud

Masukkan perintah berikut guna menampilkan project ID untuk project Google Cloud Anda:
```
gcloud projects list
```

Setel project default Anda:

gcloud config set project YOUR_PROJECT_ID

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.
Datastream Viewer: 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 memperoleh dan menetapkan izin untuk Datastream menggunakan Google Cloud Console, 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 dokumentasi Datastream berikut:

Memberikan data JSON dari file

Saat menggunakan API dengan cURL, Anda perlu memberikan nilai properti menggunakan command line. Jika Anda bekerja dengan nilai sensitif seperti sandi atau kunci keamanan, menyediakannya pada 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 tersebut pada command line.

Untuk memberikan data JSON ke panggilan API cURL dari file:

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

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

Pada command line, berikan jalur ke file, yang diawali 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, gunakan perintah cURL berikut pada 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 hingga operasi pertama selesai sebelum melanjutkan.

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

Datastream dan Layanan Penemuan Google API

Layanan Discovery Google API adalah layanan yang dapat Anda gunakan untuk menemukan Google API. Misalnya, saat Anda menggunakan alat Penjelajah Google API , Anda menggunakan Layanan Discovery.

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