All Products
Search
Document Center

DataV:Add Alibaba Cloud API Gateway data source

Last Updated:Feb 20, 2025

This document outlines how to add an Alibaba Cloud API Gateway data source in DataV and provides guidance on configuring the necessary parameters. Alibaba Cloud API Gateway is a comprehensive API hosting service that facilitates the entire lifecycle of API publishing, management, operations, and monetization.

Prerequisites

Ensure the Alibaba Cloud API Gateway data source is prepared for addition.

Add Alibaba Cloud API Gateway data source

  1. Access the DataV console.

  2. On the Workbench page, click Data Preparation > Data Source to navigate to the Data Source page, then click Create Data Source.

  3. From the Type list, select Alibaba Cloud API Gateway.

  4. Enter the API Gateway details.

    image

    Parameter

    Description

    Name

    The display name of the data source, which you can name freely.

    Domain Name

    The domain name for invoking the API Gateway. You can view it in the API Gateway console.

    AppKey

    The AppKey for invoking the API Gateway interface. For more information, see Access backend services over HTTP protocol through API Gateway to obtain the relevant interface's AppKey.

    AppSecret

    The AppSecret for invoking the API Gateway interface. For more information, see Access backend services over HTTP protocol through API Gateway to obtain the relevant interface's AppSecret.

  5. Once the information is entered, click OK to finalize the data source addition.

    The new data source will then be listed automatically.

Use Alibaba Cloud API Gateway data source

  1. Access the DataV console.

  2. On the Workbench page, hover over the data dashboard you want to edit and click Edit.

    Important

    If you haven't created a data dashboard on your Workbench page, please see Create a PC Dashboard Using a Template for guidance on creating one.

  3. On the canvas editing page, select a widget from the canvas.

    If your canvas lacks widgets, please add them first. For more information, see Widget Canvas Operations.

  4. In the widget configuration panel on the right, select Data Source.

    image

  5. In the Set Data Source section, choose Data Source Type as Alibaba Cloud API Gateway.

  6. From the Select Existing Data Source list, pick the configured Alibaba Cloud API Gateway data source.

  7. In the HTTP Method list below, select a request method. You can choose from GET, POST, PATCH, PUT, DELETE, HEAD, and OPTIONS. For explanations of these request methods, see .

  8. In the Request URL field, input the URL path for the desired interface.

  9. Based on the selected request method in HTTP Method, enter the appropriate function values in the Header (request Header) and Body (request Body) fields.

  10. Click View Data Return Results to check the returned data.