Using a Browser to Call an API Which Requires No Authentication

Prerequisites

• An API or API workflow requiring no authentication has been published. The published API is available in DataArts Catalog.

• Chrome has been installed.

Notes and Constraints

• To call an API in DataArts DataService locally, you need to bind an EIP to the DataArts DataService Exclusive cluster when creating the cluster.
• When an API in DataArts DataService is called, if the total duration of query and response exceeds 60 seconds (default value), a timeout error is reported. In this case, you can optimize the API configuration based on the API calling duration recorded in the access log.

  ____________Duration information__________ 
  duration: 60491ms //Total duration
  url_duration: 0ms //URL matching duration
  auth_duration: 70ms //Authentication duration
  befor_sql_duration: 402ms //Preprocessing duration before SQL execution
  sql_duration: 60001ms //SQL execution duration
  after_sql_duration:18ms //Postprocessing duration after SQL execution

Obtaining API Information

1. Log in to the DataArts Studio console by following the instructions in Accessing the DataArts Studio Instance Console.
2. On the DataArts Studio console, locate a workspace and click DataArts DataService.
3. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
4. Obtain the URL, request method, and input parameters of the API to be called.

   In the navigation pane on the left, choose APIs. Locate the API to be called, click the API name to access its details page, and record the URL, request method, and input parameters of the API.

   • URL for calling the API: The exclusive edition supports both private and public IP addresses. To use the public IP address, you need to bind an EIP to the cluster during cluster creation. If you want to call an API in DataArts DataService Exclusive locally, you need to use a public IP address to ensure network connectivity.
   • Input parameters: In this example, an API with Query and Path input parameters is created to describe how to enter various input parameters during an API call.
     Figure 1 Recording the URL, request method, and input parameters
     

Calling an API

1. Start Chrome and create a blank tab.
2. Enter the API calling URL obtained in Obtaining API Information in the address box of the browser and access the URL. If input parameters include Path and Query parameters, you need to change the {path} variable in the API calling URL to the value of the Path parameter, and add the value of the Query parameter to the end of the API calling URL in the following format: ?Query parameter name=Query parameter value, for example, ?query=1 in this example.

   https://xx.xx.xx.xx/getContestantInfo/2?query=1

   If you want to customize the calling result, set the following Query parameters and use & to connect parameters:

   • (Optional) Pagination configuration: By default, the system assigns pagination data to the APIs created using configuration or a script/MyBatis. If you want to obtain specified pagination data, add the following parameters. pageSize indicates the page size, and pageNum indicates the page number.

     https://xx.xx.xx.xx/getContestantInfo/2?query=1&pageSize=100&pageNum=1

     

     For APIs created using a script/MyBatis with custom pagination configuration, the pagination logic is written to the data acquisition SQL statement during API creation. Therefore, the pagination settings cannot be modified during an API call.

   • (Optional) Sorting configuration: By default, the system provides the default sorting based on the ranking parameters. By default, the custom ranking mode is ascending. To change the sorting, modify the pre_order_by parameter. The value of pre_order_by is in either of the following formats: Ranking parameter name:ASC (ascending order) or Ranking parameter name:DESC (descending order). Separate multiple ranking parameter descriptions by semicolons (;).

     https://xx.xx.xx.xx/getContestantInfo/2?query=1&pre_order_by=id:ASC;age:ASC;score:DESC

     You can change the value of pre_order_by as follows:

     • Delete an optional ranking parameter. The parameter is no longer used for ranking.
     • Change the ranking mode of a ranking parameter whose ranking mode is custom to ascending or descending. The ranking parameter is sorted based on the new ranking mode.
     

     The value of pre_order_by cannot be changed in any of the following ways. Otherwise, the change does not take effect or an error is reported during API calling.

     • If a mandatory ranking parameter is deleted, the parameter is still used for ranking and the deletion does not take effect.
     • Adjustment of the sequence of ranking parameters will not take effect. The sequence of ranking parameters configured during the creation of an API through configuration, a script, or MyBatis will still be used.
     • If you change the ranking mode of a ranking parameter whose ranking mode is ascending or descending, the API cannot be called. Such a change is not allowed.
   • (Optional) Number of returned records: If Return Total Records is enabled during API creation, it takes a long time to obtain the total number of data records if the data table corresponding to the API contains a large amount of data. In this case, if you do not want the system to calculate and return the total number of data records during an API call, you can modify the use_total_num parameter. The use_total_num parameter specifies whether to calculate and return the total number of data records. If its value is 1, the total number of data records is returned. If its value is not 1, the total number of data records is not returned.

     https://xx.xx.xx.xx/getContestantInfo/2?query=1&use_total_num=0

3. View the returned result. If "errCode":"DLM.0" is returned, the API is successfully called. If the API call fails, rectify the fault based on the error message.
   Figure 2 Using a browser to call an API