All Products
Search

This Product

    DataWorks:APIs in DataService Studio

    Document Center

    DataWorks:APIs in DataService Studio

    Last Updated:Nov 13, 2024

    Data Map allows you to search for and locate DataService Studio APIs of all workspaces within the current tenant in an efficient manner.

    Go to the DataMap page to search for APIs

    1. Go to the DataMap page.

      Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose Data Catalog > Data Map. On the page that appears, click Go to Data Map.

    2. On the homepage of Data Map, select API in the Type drop-down list below the search box.

      image.png

    Search for an API

    1. In the search box, enter a keyword such as an API ID, API path, API name, or API description.

      After you enter a keyword, the first 10 APIs that match the keyword are displayed in the drop-down list, which are the preliminary search results provided by the system.image.png

    2. If you cannot find the desired API in the drop-down list of the search box, click Search. All APIs that meet the filter condition are displayed.

      image.png

    3. Search for the desired API by configuring the API Type, Workspace, and Owner parameters that are displayed on the left of the displayed page.

    4. If you want to view the details of an API, click the name of the API to go to the API details page. For more information, see View the details of an API.

    View the details of an API

    On the details page of an API, you can view the following information about the API: basic information, technical information, parameters, sample response, and usage notes.image

    Area

    Description

    1

    In this area, you can click Edit API to go to the configuration tab of the API in the related workspace and edit the API. For more information, see Publish an API and Register an API.

    Note

    If the current logon account is not added as a member of the workspace to which the API belongs, contact the workspace administrator to add the account to the workspace as a member and assign the developer role to the account. For more information, see Manage permissions on workspace-level services.

    2

    In this area, you can view the following information about the API:

    • Basic Information: In this section, you can view basic information about the API, such as the number of times that the API is viewed, number of times that the API is called, API ID, workspace to which the API belongs, API owner, creation time, update time, and API description.

    • Technical Information: In this section, you can view the technical information about the API, such as the API type, request method, return type, data source type, data source name, and table name.

    3

    In this area, you can view the following information about the API:

    • Parameter Information: On this tab, you can view the request parameters and response parameters of the API.

      • Request Parameters: On this subtab, you can view information about common request parameters and application request parameters, such as parameter name, parameter type, parameter location, sample value, default value, description, and tag.

      • Response Parameters: On this subtab, you can view information about common response parameters and application response parameters, such as parameter name, parameter type, sample value, and description.

    • Sample Response: If you test the API and select Save the correct response example automatically during the test before the API is published, the sample response is updated based on the test result. For more information, see Test an API. You can view the result returned by an API request based on the data content and data structure on the Sample Response tab.

    • Lineage: On this tab, you can view the complete lineages of tables, APIs, and applications. The following types of data sources can be used as the ancestor lineages of the current API: Hologres, MySQL, PostgreSQL, SQL Server, Oracle, AnalyticDB for MySQL 3.0, and AnalyticDB for PostgreSQL.

      Note

      • For a generated API, the API is generated based on a data source or by encapsulating a table. The API lineage includes data tables, the API, and applications.

      • For a registered API, the API is obtained by encapsulating a backend address. The API lineage includes only the API and applications.

      • The lineage information is generated and updated with a delay of one day.

    • Usage Notes: On this tab, you can click Edit to modify the API usage notes and View Versions to view the historical versions of the API usage notes.