All Products
Search

This Product

    Hologres:DataWorks DataService Studio

    Document Center

    Hologres:DataWorks DataService Studio

    Last Updated:Mar 26, 2026

    DataWorks DataService Studio lets you build a unified data service bus. With it, you can:

    • Generate REST APIs directly from Hologres data tables — no backend code required

    • Register existing APIs with a central data service platform

    • Manage and publish API services in one place

    Because Hologres is deeply integrated with DataWorks, you can connect directly to DataService Studio and expose queried data as external APIs in minutes.

    Prerequisites

    Before you begin, ensure that you have:

    • Activated DataWorks. For setup, see Get started

    • An active Hologres instance attached to a DataWorks workspace

    Step 1: Create a Hologres data source

    Register Hologres as a data source in the DataWorks console so DataService Studio can query it.

    Log on to the DataWorks console and create a Hologres data source. For instructions, see Attach a Hologres computing resource.

    Step 2: Generate an API

    Create a new API that reads from your Hologres data source. DataService Studio supports two modes: Codeless UI for visual configuration and Code Editor for SQL-based control.

    1. On the DataWorks developer interface, click the 图标 icon in the upper-left corner.

    2. Hover over All Products and click Data Service > Data Service.

    3. On the Service Development page, hover over the 新建 icon.

    4. Hover over New API > Generate API, then choose a mode:

      Generate API

    Step 3: Test the API

    Run a test against the API before publishing to confirm it returns the expected data.

    1. On the API editing page, click Test in the upper-right corner.

    2. In the API Test dialog box, enter the request parameters and click Start Test. If Test successful appears at the bottom of the API Test dialog box, the API test is passed.

      Test

    For more testing options, see Test an API.

    Step 4: Publish the API

    Publish the API to make it accessible to external callers.

    1. On the API editing page, click Publish in the upper-right corner. To publish to API Gateway and list the API in the API marketplace, see Publish an API.

    2. On the DataService Studio page, click Service Management in the upper-right corner.

    3. Click the name of the published API to view its details.

    Step 5: Call the API

    To call the successfully published API, see Examples of calling an API from a client.

    What's next