DataWorks：Gunakan API untuk menyediakan layanan data

Langkah 1: Buat API profil pengguna

Operasi dalam contoh ini dilakukan menggunakan fitur API dari DataService Studio.

1. Masuk ke Konsol DataWorks. Di bilah navigasi atas, pilih wilayah yang diinginkan. Di panel navigasi kiri, pilih Data Analysis and Service > DataService Studio. Pada halaman yang muncul, pilih ruang kerja yang diinginkan dari daftar drop-down dan klik Go to DataService Studio.

2. Buat API.

   Di panel Pengembangan Layanan halaman DataService Studio, klik ikon dan pilih Create API > Generate API. Dalam kotak dialog Generate API, konfigurasikan parameter untuk membuat API menggunakan codeless UI.

   Catatan

   Anda dapat membuat API menggunakan UI tanpa kode atau editor kode. Dalam contoh ini, API dibuat menggunakan UI tanpa kode.

   • Untuk informasi tentang cara membuat API menggunakan UI tanpa kode, lihat Buat API dengan menggunakan UI tanpa kode.

   • Untuk informasi tentang cara membuat API menggunakan editor kode, lihat Buat API dengan menggunakan editor kode.

Langkah 2: Konfigurasikan API profil pengguna

1. Konfigurasikan detail untuk API profil pengguna.

   Setelah membuat API profil pengguna menggunakan UI tanpa kode, konfigurasikan parameter yang dijelaskan dalam tabel berikut untuk menentukan detail API. Dalam contoh ini, API profil pengguna yang menggunakan sumber data StarRocks dikonfigurasi. Untuk informasi lebih lanjut tentang cara membuat API menggunakan UI tanpa kode, lihat Buat API dengan menggunakan UI tanpa kode.

   Bagian	Parameter	Deskripsi	Contoh
   Select Table	Datasource Type	Tipe sumber data. Catatan Layanan data berbasis API tidak mendukung sumber data Hive. Anda dapat melihat tipe sumber data yang didukung saat mengonfigurasi parameter Tipe Sumber Data.	Dalam contoh ini, StarRocks dipilih.
   	Datasource Name	Sumber data yang ditambahkan.	Dalam contoh ini, sumber data bisnis Doc_StarRocks_Storage_Compute_Tightly_01 digunakan.
   	Datasource Env.	Production Development	Dalam contoh ini, Production dipilih.
   	Table Name	Tabel yang perlu digunakan oleh API.	Dalam contoh ini, tabel ads_user_info_1d_StarRocks dipilih.
   Select Parameters	Pagination for Return Results	Menentukan apakah akan membagi hasil kembali menjadi beberapa halaman. Pengaturan parameter ini memengaruhi konfigurasi parameter permintaan dan parameter respons. Jika Anda mengaktifkan Paginasi untuk Hasil Kembali, klik Grup Sumber Daya di panel navigasi kanan, dan konfigurasikan parameter Jumlah Maksimum Catatan Data untuk Permintaan Tunggal pada tab Grup Sumber Daya berdasarkan tipe grup sumber daya yang Anda tentukan. Untuk informasi lebih lanjut, lihat Konfigurasikan API.	Dalam contoh ini, Pagination for Return Results dimatikan.
   	Set as Req Param	Bidang yang ingin Anda tetapkan sebagai parameter permintaan. Anda dapat menetapkan beberapa bidang sebagai parameter permintaan.	Dalam contoh ini, bidang partisi dt ditetapkan sebagai request parameter.
   	Set as Resp Param	Bidang yang ingin Anda tetapkan sebagai parameter respons. Anda dapat menetapkan beberapa bidang sebagai parameter respons.	Dalam contoh ini, semua bidang dalam tabel ads_user_info_1d_StarRocks ditetapkan sebagai response parameters.
   Sort field	Konfigurasi di bagian Bidang Urutkan bersifat opsional. Jika Anda ingin mengurutkan data yang dikembalikan oleh API berdasarkan bidang tertentu, temukan bidang tersebut dan klik Tambahkan di kolom Tambahkan ke urutan bidang. Setelah Anda mengklik Tambahkan, bidang tersebut ditambahkan ke bagian Bidang Urutkan.		Dalam contoh ini, tidak ada bidang yang ditambahkan untuk mengurutkan data yang dikembalikan oleh API.

2. Konfigurasikan grup sumber daya untuk DataService Studio.

   Setelah API dikonfigurasi, klik Resource Group di panel navigasi kanan untuk mengonfigurasi grup sumber daya. Tabel berikut menjelaskan parameter yang dapat Anda konfigurasikan. Untuk informasi lebih lanjut, lihat Konfigurasikan grup sumber daya untuk DataService Studio.

   Bagian	Parameter	Deskripsi
   Resource Group Type	Scheme	Pilih Exclusive Resource Group for DataService Studio.
   	Exclusive Resource Group for DataService Studio	Pilih grup sumber daya eksklusif untuk DataService Studio atau grup sumber daya serverless (disarankan). Penting Jika Anda telah membeli grup sumber daya eksklusif untuk DataService Studio, Anda dapat langsung memilihnya. Jika tidak ada grup sumber daya yang tersedia, kami sarankan Anda membeli grup sumber daya serverless. Untuk informasi lebih lanjut, lihat Buat dan gunakan grup sumber daya serverless. Jika grup sumber daya serverless yang Anda beli redup dan tidak dapat dipilih, Anda harus mengonfigurasi kuota unit komputasi (CU) untuk grup sumber daya untuk DataService Studio. Untuk informasi lebih lanjut, lihat Kelola kuota.
   Environment Configuration	Function Timeout	Atur nilainya menjadi 30000. Unit: milidetik.
   	Maximum Number of Data Records for a Single Request	Atur nilainya menjadi 2000.

Langkah 3: Uji dan publikasikan API

1. Uji API untuk memeriksa apakah parameter respons yang dikembalikan oleh API memenuhi harapan Anda. Untuk informasi lebih lanjut, lihat Uji API.

   1. Setelah konfigurasi selesai, klik ikon di bilah alat atas untuk menyimpan API dan klik ikon di bilah alat atas untuk membuka kotak dialog Uji API.

   2. Dalam kotak dialog Test APIs, tentukan nilai untuk semua parameter permintaan API.

   3. Klik Test untuk menguji API.

2. Publikasikan API ke API Gateway. Setelah API diterbitkan ke API Gateway, alamat panggilan online dihasilkan. Anda dapat melakukan operasi berikut untuk menerbitkan API ke API Gateway. Untuk informasi lebih lanjut, lihat Publikasikan API.

   1. Jika pengujian pada API berhasil, klik ikon di bilah alat atas pada tab konfigurasi API untuk mengirimkan API. Setelah API dikirimkan, versi dihasilkan untuk API. Untuk melihat informasi tentang semua versi yang dihasilkan untuk API, klik Version di panel navigasi kanan.

   2. Klik Publish di kolom Tindakan versi untuk menerbitkan API versi ini.

   3. Setelah API versi ini diterbitkan, klik Service Management di kolom Tindakan versi untuk mengelola API. Atau, klik Service Management di bilah navigasi atas dan kelola API pada tab Published APIs halaman Manage APIs. Untuk informasi lebih lanjut, lihat topik-topik dalam direktori Kelola dan pertahankan API.