Updated on 2022-12-05 GMT+08:00

Viewing API Calling Information

Overview

ROMA Connect provides visualized API analysis and statistics. You can view API calling statistics and call logs on the ROMA Connect console.

Viewing API Calling Statistics

  1. Log in to the ROMA Connect console. On the Instances page, click View Console next to a specific instance.
  2. In the navigation pane on the left, choose API Connect > API Analysis. On the API Calling tab page, you can view the API calling statistics.
    • You can view the real-time statistics on the total number of APIs, total number of API groups, and total number of request throttling policies.
    • You can view the calling statistics of an API, including the number of requests, number of errors, data traffic, and call delay.

      Select an integration application and API to filter your required API. You can also select the time range of the data to be viewed.

Viewing API Calling Logs

  1. Log in to the ROMA Connect console. On the Instances page, click View Console next to a specific instance.
  2. In the navigation pane, choose API Connect > API Analysis.
  3. Enable the log analysis function.
    1. On the Access Logs tab page, click Configure Access Log.
    2. In the Configure Access Log dialog box, configure log access information and click OK.
      Table 1 Parameters for configuring an access log

      Parameter

      Description

      Collect Access Logs

      Determine whether to enable the logging function. API calling logs can be viewed only after you enable Collect Access Logs.

      Log Group

      Select the log group to which the log stream belongs.

      If no log group is available, click View Log Group to switch to the LTS console and create a log group. For details, see "Log Management > Creating a Log Group" in the Log Tank Service User Guide.

      Log Stream

      Select the log stream to be stored in API calling logs.

      If no log stream is available, click View Log Stream to switch to the LTS console and create a log stream. For details, see "Log Management > Creating a Log Stream" in the Log Tank Service User Guide.

  4. After the log analysis function is enabled, you can view the calling logs of all open APIs in real time on the console.
    • In the upper right corner of the page, you can select the time segment of the logs to be viewed.
    • Click Log Field Description in the upper right corner to view the log field description.
    • To download logs, you can configure log dump on the LTS console. For details, see "Log Transfer" in the Log Tank Service User Guide.