Registering APIs

Configuring Basic API Information

1. On the DataArts Studio console, locate an instance and click Access. On the displayed page, locate a workspace and click DataArts DataService.

2. In the left navigation pane, choose DataArts DataService Shared. The Overview page is displayed.
3. Choose API Development > APIs in the left navigation bar, and click Register. Configure the basic information.

   Table 1 API basic configuration

   Parameter	Description
   API	An API name consists of 3 to 64 characters and starts with a letter. Only letters, numbers, and underscores (_) are allowed.
   API Catalog	An API catalog is a set of APIs with a specific function or scenario. It is the minimum organization unit of APIs in DataArts DataService and the minimum management unit of API Gateway. Click Select Catalog to create an API catalog or select an existing one created in Creating an API Directory.
   Request Path	The path for accessing an API. Example: /v2/{project_id}/streams.
   Protocol	A protocol used to transmit requests. HTTP and HTTPS are supported.
   Request Mode	HTTP defines the following request modes that can be used to send a request to the server. GET requests the server to return specified resources. POST requests the server to add resources or perform special operations. This method is recommended for API registration. The POST request does not have a body. Instead, it involves transparent transmission.
   Description	A brief description of the API to be registered.
   Tag	The name of the tag. Only letters, numbers, and underscores (_) are allowed. Tag names cannot start with underscores (_).
   Reviewer	An owner who has permissions to review APIs. Click Add to enter the Review Center page. On the page displayed, click Add on the Reviewer Management tab page to add a reviewer.
   Security Authentication	Security authentication mode, which can be: App Authentication: API Gateway authenticates API requests. IAM Authentication: IAM authenticates API requests. Non-authentication: No authentication is required.
   Display Scope	After the API is published, all users in the selected scope can view the API in the service catalog. Current workspace APIs Current project APIs Current tenant's APIs
   Access Log	If you select this option, the API query result will be recorded and retained for seven days. You can choose Operations Management > Access Logs and select the request date to view the logs.
   Min. Retention Period	Minimum duration reserved before API unbinding. Before an API developer suspends, unpublishes, or cancels the authorization of an API, the system notifies the authorized API callers and reserves at least X hours for them to unbind the API. During the retention period, the API can be used if it is not unbound. The value 0 indicates that there is no minimum retention period.
   Input Parameter	Input parameter is a set of parameters in the API request, including dynamic parameters in the resource path, query parameters in the request URI, and header parameters. The following is an example that describes the dynamic parameters in the resource path (request path): /v2/{project_id}/streams, where {project_id} is a dynamic parameter that needs to be configured. Click Add and enter project_id for Name. Set Parameter Location to PATH. Set Type to STRING. Set Example Value and Description as required.

4. After the basic API information is complete, click Next to go to the Data Extract Logic page.

Configuring API Parameters

After configuring basic API information, you can set API parameters. The following describes how to configure the API backend services and request parameters.

Testing an API

After all parameters are set, click Debug. Specify Value and click Debug. You can view the Request and Response details on the right part of the page displayed. If the test fails, follow the instructions as prompted and restart the test. During the configuration, pay attention to the settings of the normal response example.

After the test is complete, click OK.