All Products
Search
Document Center

DataWorks:API layanan data

Last Updated:Aug 21, 2026

Modul DataService Studio di DataWorks memungkinkan Anda mengekspos data melalui API untuk aplikasi bisnis Anda. Topik ini menjelaskan cara membuat API layanan data menggunakan skenario contoh.

Prasyarat

Buat API profil pengguna

Sinkronisasi dan pemrosesan data Anda menghasilkan tabel ads_user_info_1d. Untuk mengekspos data ini melalui API, gunakan fitur API di DataService Studio. Anda dapat menghasilkan API dalam Wizard Mode atau Script Mode.

Langkah 1: Hasilkan API profil pengguna

Lakukan langkah-langkah berikut di DataService Studio.

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

  2. Buat API.

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

    Catatan

    Anda dapat menghasilkan API dalam Wizard Mode atau Script Mode. Contoh ini menggunakan Wizard Mode.

Langkah 2: Konfigurasi API profil pengguna

  1. Konfigurasi API.

    Dalam Wizard Mode, konfigurasikan parameter berikut untuk membuat API layanan data dari sumber data MaxCompute. Untuk informasi selengkapnya, lihat Generate an API from a data source (API Gateway).

    Modul

    Parameter

    Deskripsi

    Contoh

    Table

    Data Source Type

    Pilih tipe sumber data.

    Catatan

    API layanan data tidak mendukung sumber data Hive. Tipe sumber data yang tersedia dibatasi pada opsi dalam daftar drop-down.

    Contoh ini menggunakan sumber data MaxCompute.

    Data Source Name

    Pilih sumber data yang sudah ada.

    Gunakan sumber data bisnis Anda.

    Data Source Environment

    • Production Environment

    • Development Environment

    Pilih Production Environment.

    Data Table Name

    Pilih tabel untuk API.

    Pilih tabel ads_user_info_1d.

    Select Parameters

    Pagination for Return Results

    Aktifkan atau nonaktifkan pagination untuk hasil. Pengaturan ini memengaruhi parameter permintaan dan respons API.

    Di panel Service Resource Group di sebelah kanan, Anda dapat mengatur jumlah maksimum catatan data untuk satu permintaan berdasarkan tipe kelompok sumber daya. Untuk informasi selengkapnya, lihat Generate an API from a data source (API Gateway).

    Nonaktifkan Pagination for Return Results.

    Set as Req Param

    Pilih bidang yang akan digunakan sebagai parameter permintaan.

    Tetapkan bidang partisi dt sebagai Request Parameters.

    Set as Resp Param

    Pilih bidang yang akan digunakan sebagai parameter respons.

    Tetapkan semua bidang dalam tabel ads_user_info_1d sebagai Response Parameters.

    Sorting Fields

    Bidang pengurutan bersifat opsional. Jika Anda ingin mengurutkan berdasarkan bidang tertentu, pilih terlebih dahulu bidang tersebut dari daftar parameter.

    Jangan urutkan.

  2. Konfigurasi kelompok sumber daya layanan

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

    Modul

    Parameter

    Deskripsi

    Resource Group Type

    Scheme

    Exclusive Resource Group for DataService Studio.

    Exclusive Resource Group for DataService Studio

    Pilih 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 Anda belum memiliki resource group, kami menyarankan untuk membeli resource group serverless serbaguna. Untuk informasi selengkapnya, lihat Use a serverless resource group.

      Jika resource group serverless yang baru dibeli berwarna abu-abu dan tidak dapat dipilih saat Anda mengonfigurasi service resource group, Anda harus mengalokasikan kuota untuk penggunaan Data Services pada resource group tersebut. Untuk informasi selengkapnya, lihat Allocate CU quotas to tasks.

    Environment Configuration

    Timeout

    Tetapkan nilai menjadi 30000 ms.

    Maximum Number of Data Records for a Single Request

    Tetapkan nilai menjadi 2000.

Langkah 3: Uji dan publikasikan API

  1. Uji API untuk memverifikasi bahwa API mengembalikan parameter respons yang diharapkan. Untuk informasi selengkapnya, lihat Test an API.

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

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

    3. Klik Start Test untuk memulai pengujian API.

  2. Publikasi API akan menambahkannya ke API Gateway dan menghasilkan titik akhir online. Untuk informasi selengkapnya, lihat Test, publish, and manage versions of an API.

    1. Setelah API lolos pengujian, klik ikon image di halaman pengeditan API untuk mengirimkan API. Versi API baru akan dihasilkan. Di panel sebelah kanan halaman detail API, klik tab Version untuk membuka halaman manajemen versi. Temukan versi dengan status Publishable, misalnya v1.

    2. Klik Publish untuk mempublikasikan API.

    3. Setelah API dipublikasikan, Anda dapat mengklik Service Management di bagian manajemen versi atau navigasi ke Service Management > API Management > Published APIs. Untuk informasi selengkapnya, lihat Manage and maintain APIs.

Langkah berikutnya

Setelah API dipublikasikan, Anda dapat authorize dan call API tersebut. Untuk informasi selengkapnya, lihat Authorize an API dan Call an API.