DataWorks：Menggunakan API untuk menyediakan layanan data

Langkah 1: Menghasilkan API persona pengguna

Contoh ini menjelaskan operasi yang diperlukan untuk menggunakan fitur API di Studio Layanan Data.

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

2. Buat layanan API.

   Pada halaman Studio Layanan Data, klik ikon dan pilih New API > Generate API. Di kotak dialog Generate API, pilih Codeless UI untuk menghasilkan API.

   Catatan

   Anda dapat menghasilkan API dalam mode Antarmuka Tanpa Kode atau Editor Kode. Topik ini menggunakan mode Antarmuka Tanpa Kode sebagai contoh.

   • Untuk informasi selengkapnya, lihat Menghasilkan API di antarmuka tanpa kode.

   • Untuk informasi selengkapnya, lihat Menghasilkan API di editor kode.

Langkah 2: Mengonfigurasi API persona pengguna

1. Konfigurasi detail.

   Setelah membuat API persona pengguna di antarmuka tanpa kode, konfigurasikan parameter untuk mengimplementasikan layanan data API untuk sumber data MaxCompute. Untuk informasi selengkapnya, lihat Menghasilkan API di antarmuka tanpa kode.

   Bagian	Parameter	Konfigurasi	Contoh
   Select Table	Data Source Type	Pilih jenis sumber data. Catatan Layanan data berbasis API tidak mendukung sumber data Hive. Jenis sumber data yang didukung ditampilkan dalam daftar drop-down.	Contoh ini menggunakan sumber data MaxCompute.
   	Data Source Name	Pilih sumber data yang telah dibuat.	Gunakan sumber data bisnis.
   	Data Source Environment	Production Environment Development Environment	Pilih Production Environment.
   	Table Name	Pilih tabel yang akan digunakan oleh API.	Pilih tabel ads_user_info_1d.
   Select Parameters	Paging For Return Results	Menentukan apakah penomoran halaman diaktifkan untuk hasil yang dikembalikan. Pengaturan ini memengaruhi parameter permintaan dan respons API. Di pengaturan kelompok sumber daya layanan di panel navigasi kanan, Anda dapat mengatur jumlah maksimum catatan data untuk satu permintaan berdasarkan jenis kelompok sumber daya. Untuk informasi selengkapnya, lihat Mengonfigurasi API.	Matikan Paging For Return Results.
   	Set As Request Parameter	Tetapkan satu atau beberapa bidang dalam tabel sebagai parameter permintaan.	Tetapkan bidang partisi dt sebagai Request Parameter.
   	Set As Response Parameter	Tetapkan satu atau beberapa bidang dalam tabel sebagai parameter respons.	Tetapkan semua bidang dalam tabel ads_user_info_1d sebagai Response Parameters.
   Sort Field	Parameter ini bersifat opsional. Untuk mengurutkan hasil berdasarkan suatu bidang, pilih terlebih dahulu bidang tersebut dari daftar parameter.		Tidak ada pengurutan yang dikonfigurasi.

2. Konfigurasi kelompok sumber daya layanan

   Setelah mengonfigurasi API di antarmuka tanpa kode, klik Service Resource Group di panel navigasi kanan untuk mengonfigurasi sumber daya layanan. Tabel berikut menjelaskan parameter-parameter tersebut. Untuk informasi selengkapnya, lihat Mengonfigurasi kelompok sumber daya layanan untuk API.

   Bagian	Parameter	Konfigurasi
   Resource Group Type	Scheme	Exclusive Resource Group For DataService Studio.
   	Exclusive Resource Group For DataService Studio	Pilih kelompok sumber daya serverless (disarankan) atau kelompok sumber daya eksklusif untuk Studio Layanan Data. Penting Jika Anda telah membeli kelompok sumber daya eksklusif untuk Studio Layanan Data, Anda dapat langsung menggunakannya. Jika tidak tersedia kelompok sumber daya, beli kelompok sumber daya serverless serbaguna. Untuk informasi selengkapnya, lihat Menggunakan kelompok sumber daya serverless. Jika kelompok sumber daya serverless yang baru dibeli berwarna abu-abu dan tidak dapat dipilih saat Anda mengonfigurasi kelompok sumber daya layanan, Anda harus mengalokasikan kuota untuk penggunaan DataService Studio dari kelompok sumber daya tersebut. Untuk informasi selengkapnya, lihat Mengalokasikan kuota CU ke tugas.
   Environment Configuration	Timeout	Atur nilainya menjadi 30000 ms.
   	Maximum Number Of Data Records For A Single Request	Atur nilainya menjadi 2000.

Langkah 3: Menguji dan menerbitkan API

1. Uji API untuk memverifikasi bahwa parameter yang dikembalikan sesuai dengan harapan Anda. Untuk informasi selengkapnya, lihat Menguji API.

   1. Setelah konfigurasi selesai, klik ikon untuk menyimpan API, lalu klik ikon untuk membuka halaman uji API.

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

   3. Klik Start Test untuk menguji API.

2. Terbitkan API ke Gerbang API untuk menghasilkan titik akhir online. Untuk informasi selengkapnya, lihat Menerbitkan API.

   1. Setelah API lulus pengujian, pada halaman pengeditan API, klik ikon untuk mengirimkan API. Versi API baru dihasilkan. Anda dapat mengklik Version di sisi kanan halaman untuk melihat informasi tentang versi API yang telah dikirim.

   2. Klik Publish untuk menerbitkan layanan API.

   3. Setelah API diterbitkan, Anda dapat mengelola API yang diterbitkan dengan mengklik Service Management di bagian Manajemen Versi atau dengan menavigasi ke Service Management > API Management > Published APIs. Untuk informasi selengkapnya, lihat Mengelola dan memelihara API.