DataWorks:Layanan data API

Langkah 1: Hasilkan API profil pengguna

Contoh ini menggunakan fitur API di DataService Studio.

1. Masuk ke Konsol DataWorks. Di Wilayah target, klik Data Analysis and Service > DataService Studio di panel navigasi kiri. Pilih ruang kerja dari daftar drop-down dan klik Go to DataService Studio.

2. Buat layanan API.

   Di DataService Studio, klik ikon dan pilih Create API > Generate API. Di kotak dialog Generate API, pilih Wizard Mode.

   Catatan

   DataService Studio menyediakan dua metode untuk menghasilkan API: codeless UI dan code editor. Contoh ini menggunakan codeless UI.

   • Untuk informasi selengkapnya tentang menghasilkan API menggunakan codeless UI, lihat Generate an API from a data source (API Gateway).

   • Untuk informasi selengkapnya tentang menghasilkan API menggunakan code editor, lihat Generate an API by using the code editor.

Langkah 2: Konfigurasi API profil pengguna

1. Konfigurasi detail API.

   Di codeless UI, konfigurasikan parameter berikut untuk API sumber data StarRocks. Untuk informasi selengkapnya, lihat Generate an API from a data source (API Gateway).

   Modul	Parameter	Deskripsi	Contoh
   Table	Data Source Type	Jenis sumber data Anda. Catatan API DataService Studio tidak mendukung sumber data Hive. Jenis yang didukung tercantum dalam daftar drop-down.	Topik ini menggunakan sumber data StarRocks sebagai contoh.
   	Data Source Name	Sumber data yang telah Anda buat.	Gunakan sumber data bisnis Doc_StarRocks_Storage_Compute_Tightly_01.
   	Data Source Environment	Production Environment Development Environment	Pilih Production Environment.
   	Data Table Name	Tabel yang akan digunakan oleh API.	Pilih tabel ads_user_info_1d_StarRocks.
   Select Parameters	Pagination for Return Results	Apakah Anda mengaktifkan pagination memengaruhi cara Anda mengatur parameter permintaan dan parameter respons untuk API. Di bagian Resource Group di panel navigasi kanan, Anda dapat mengatur Maximum Number of Data Records for a Single Request berdasarkan jenis kelompok sumber daya. Untuk informasi selengkapnya, lihat Generate an API from a data source (API Gateway).	Pagination for Return Results dinonaktifkan.
   	Set as Req Param	Bidang tabel yang akan digunakan sebagai parameter permintaan.	Tetapkan bidang partisi dt sebagai Request Parameters.
   	Set as Resp Param	Bidang tabel yang akan digunakan sebagai parameter respons.	Tetapkan semua bidang tabel ads_user_info_1d_StarRocks sebagai Response Parameters.
   Sorting Fields	Parameter ini opsional. Jika Anda ingin mengurutkan berdasarkan bidang, pilih terlebih dahulu bidang tersebut di daftar Select Parameters.		Jangan urutkan.

2. Konfigurasi kelompok sumber daya untuk layanan

   Setelah mengonfigurasi API di codeless UI, klik Resource Group for DataService Studio di panel navigasi kanan untuk mengonfigurasi sumber dayanya. Tabel berikut menjelaskan parameter-parameter tersebut. Untuk informasi selengkapnya, lihat Configure a resource group for the API.

   Modul	Parameter	Deskripsi
   Resource Group Type	Scheme	Exclusive Resource Group for DataService Studio.
   	Exclusive Resource Group for DataService Studio	Anda dapat memilih resource group serverless (disarankan) atau Exclusive Resource Group for DataService Studio. Penting Jika Anda telah membeli Exclusive Resource Group for DataService Studio, Anda dapat langsung menggunakannya. Jika tidak tersedia resource group, kami menyarankan Anda membeli resource group serverless serbaguna. Untuk informasi selengkapnya, lihat Use a serverless resource group. Jika resource group serverless yang baru dibeli tampak redup dan tidak dapat dipilih saat Anda mengonfigurasi resource group, alokasikan kuota untuk tujuan Data Services pada resource group tersebut. Untuk informasi selengkapnya, lihat Allocate CU quotas to a task.
   Environment Configuration	Timeout	Periode timeout untuk fungsi, dalam milidetik. Contoh: 30.000.
   	Maximum Number of Data Records for a Single Request	Jumlah maksimum record yang dapat dikembalikan oleh satu permintaan. Contoh: 2.000.

Langkah 3: Uji dan terbitkan API

1. Uji API untuk memverifikasi bahwa responsnya benar. Untuk informasi selengkapnya, lihat Test an API.

   1. Setelah konfigurasi selesai, klik ikon Save, lalu klik ikon Test untuk membuka halaman pengujian API.

   2. Di kotak dialog Test APIs, masukkan nilai untuk parameter permintaan.

   3. Klik Start Test untuk menguji API. Misalnya, atur nama parameter menjadi dt, jenis parameter menjadi STRING, lokasi parameter menjadi QUERY, dan nilainya menjadi 20240522. Anda dapat memilih Auto-save success response as example dan klik Test. Jika pengujian berhasil, bagian Request Details menampilkan pernyataan SQL yang dieksekusi dan log. Respons menunjukkan keberhasilan dengan errCode bernilai 0, errMsg 'success', dan hasil kueri di bidang data.

2. Menerbitkan API berarti merilisnya ke API Gateway untuk menghasilkan titik akhir publik. Untuk informasi selengkapnya, lihat Test, publish, and manage versions of an API.

   1. Setelah API lolos pengujian, klik ikon Submit di halaman pengeditan API. Tindakan ini menghasilkan versi API baru. Klik tab Version di sebelah kanan untuk membuka panel manajemen versi. Di daftar versi, temukan versi target, misalnya v1, dengan status Publishable.

   2. Klik Publish.

   3. Setelah API diterbitkan, Anda dapat mengelolanya di halaman Service Management. Akses halaman ini dengan mengklik Service Management di panel manajemen versi atau melalui navigasi Service Management > Manage APIs > Published APIs. Untuk informasi selengkapnya, lihat Manage and maintain APIs.