Data Service O&M

Version

Application Scenario

After releasing APIs, you want to manage and monitor API tasks, view the running status and API calls, and activate and deactivate APIs in batches.

Function Description

FineDataLink allows you to manage and monitor API tasks, view the running status and API calls, and activate and deactivate APIs in batches.

You can view and edit all API tasks within your permission scope in the API list. For details, see Data Service API Management Permission.

1. Click the icon on the right side of an API, where you can rename, relocate, export, and delete the API, and copy and paste the API to a path, as shown in the following figure.

Note:

Starting from FineDataLink V4.2.4.3, a directory tree refresh button is added to API List. You can click it to refresh the directory tree.

The following table describes the setting items.

2. In FineDataLink of V4.1.6.5 and later versions, you can drag an API/folder to a new position, as shown in the following figure.

• All users can manually reorder APIs/folders on which they have permission.

• The new order works on all users' pages.

• For example, a user sees top-down APIs E, A, and G, and an admin sees top-down APIs E, F, A, I, and G. If the user places G between E and A and G is shown between F and A on the admin’s page, G is placed near the lower target node. (In this scenario, APIs E and A are target nodes, and A is the lower one.) The same rule applies to folders.

For details, see Binding an API to an Application.

Viewing the API List by API Task

Choose O&M Center > Data Service > API Management and select an API folder/task. You can view the number of activated and deactivated APIs, as shown in the following figure.

You can filter APIs by creation time range, API status, API name, and creator, as shown in the following figure.

You can click Call Record in the task list after filtering to view call records, as shown in the following figure.

Additionally, you can click corresponding icons to enter the API editing page or publish the API, as shown in the following figure.

Viewing the API List by App

Choose O&M Center > Data Service > API Management > App and select an application or folder. You can view the number of activated and deactivated APIs, as shown in the following figure.

You can filter API tasks of applications in a specified folder by API creation time range, API status, and creator, as shown in the following figure.

Similarly to the "Viewing the API List by API Task" section, you can also easily view call records, and edit and publish APIs after filtering.

Activating/Deactivating APIs in Batches

You can activate/deactivate APIs in batches on both API and App pages.

Select multiple APIs to be activated/deactivated, and click the Batch Activate/Batch Deactivate button, as shown in the following figure.

The details are as follows:

• You can select all tasks on the current page with one click to activate/deactivate them in batches.

• If the selected APIs are all in the deactivated status, the Batch Deactivate button will be displayed in grey. If the APIs are all in the activated status, the Batch Activate button will be displayed in grey.

• The overwriting logic is used. For example, if you click Batch Activate, activated APIs will continue being activated, while deactivated APIs will be activated.

You will be informed of the results of the operation, as shown in the following figure:

Viewing Call Records by API Task

Choose O&M Center > Data Service > Call Record and select a task or folder. You can view the number of successful and failed API calls, as shown in the following figure.

Note:

The caller IP addresses recorded under O&M Center > Data Service > Call Record are not subject to the configuration of the Nginx reverse proxy for FineDataLink.

Filtering call records by API Name and Caller IP is supported. It helps the API maintainer review call records by API name and caller IP address, as shown in the following figure.

You can filter records by API call time range and call status, as shown in the following figure.

Starting from FineDataLink V4.2.5.4, you can configure the call detail table header, including reordering and hiding fields, as shown in the following figure.

Viewing Call Records by App

Choose O&M Center > Data Service > Call Record > App and select an application or folder. You can view the total number of calls of all APIs bound with the application and the number of server failures and client failures, as shown in the following figure.

Filtering call records by API Name and Caller IP is supported. It helps the API maintainer review call records by API name and caller IP address, as shown in the following figure.

You can filter records by API call time range and call status, as shown in the following figure.

The call status display is the same as that in the "Viewing Call Records by API Task" section.

Starting from FineDataLink V4.2.5.4, you can configure the call detail table header, including reordering and hiding fields, as shown in the following figure.