All Products
Search
Document Center

DataWorks:View and manage API versions

Last Updated:Mar 31, 2025

DataService Studio generates a version record each time an API, a function, or a workflow is published. This topic describes how to view the versions of an API, compare two versions, and roll back to a specified version.

Procedure

  1. Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose Data Analysis and Service > DataService Studio. On the page that appears, select the desired workspace from the drop-down list and click Go to DataService Studio.

  2. In the top navigation bar, select the region in which your workspace resides. In the left-side navigation pane, click DataService Studio. On the page that appears, select a workspace from the drop-down list and click Go to DataService Studio.

  3. In the left-side navigation pane of the Service Development tab on the DataService Studio page, double-click the name of the API whose versions you want to view and manage.

    Note

    You can also double-click the name of a workflow or a function to manage the versions of the workflow or function.

  4. On the configuration tab of the API, click Version in the right-side navigation pane to view versions of the API.

    版本

    Parameter

    Description

    API ID

    The ID of the API. Each API ID is unique.

    Version

    The version of the API. A version is generated each time the API is published. V1 indicates version 1 and V2 indicates version 2. The version number increases by 1 each time an additional version is generated.

    Submitted By

    The user who published the version.

    Submitted At

    The time when the version was published. The time is accurate to second.

    Status

    The status of the version. Value values:

    • Release: indicates that the version of the API is the latest version.

    • Off-Line: indicates that the version of the API is a historical version.

    Actions

    The operations that you can perform on the API. Valid values:

    • Version Details: View the details of the API.

    • Roll Back: Roll back to a specified version. After you click Roll Back, the Are you sure you want to roll back the current version message appears. Click OK.

    You can also perform the following operations to compare two versions: On the Version tab, select two versions and click Compare. In the History Version Contrast message, compare the parameters or SQL statements of the selected versions.

    Note

    The information appears in the History Version Contrast message varies based on the mode in which the API was created.

    • If the API was created in wizard mode, the request parameters and response parameters of the two versions are compared.

    • If the API was created in script mode, the SQL statements of the two versions are compared.