Updated on 2025-09-09 GMT+08:00

Viewing API Access Logs

After APIs are called, access logs are generated and stored on cluster nodes by default. You can choose Operations Management > Access Logs to view cluster node logs. For details, see Viewing Access Logs. If you are using an exclusive cluster, you can dump cluster logs to LTS or OBS buckets. Before dumping cluster logs to LTS, you need to configure LTS and create log groups and log streams. Then you can select them when dumping cluster logs.

Notes and Constraints

Only logs of exclusive clusters can be dumped.

Configuring LTS

To view logs of DataArts DataService APIs, you need to first configure LTS. For details about how to configure LTS, see Log Tank Service User Guide.

  1. Create a log group on the LTS console.

    1. Log in to the management console.
    2. Click in the upper left corner and select a region and project.
    3. Click Service List and click Log Tank Service under Management & Governance.
      Figure 1 Accessing the LTS console

    4. In the navigation pane on the left, choose Log Management.
    5. Click Create Log Group. In the displayed dialog box, enter a log group name.
    6. Click OK.

  2. Create a log stream.

    1. Click the name of the created log group.
    2. Click Create Log Stream. In the displayed dialog box, enter a log stream name.
    3. Click OK.

Enabling Dump of DataArts DataService Logs

Log in to the DataArts DataService Exclusive console, enter the Basic Details page of a cluster, enable Dump Log, and select LTS.
Figure 2 Enabling dump of logs to LTS

Viewing LTS Logs

If you have enabled log dump, you can view API access logs on the LTS console.

On the LTS console, click the name of the corresponding log stream. On the Raw Logs page, you can view access logs.

The following figure shows the log format, which cannot be changed.
Figure 3 Log format

Viewing Access Logs

In the navigation pane on the left, choose Operations Management > Access Logs. Logs of all cluster nodes are displayed on this page. Through access logs, you can view API calling details. You can view access logs on the My APIs or My Apps page.

  • By default, access logs of shared clusters record only the first 10,000 user access records every day.
  • Access logs are retained for seven days and expired logs are deleted at 23:00 every day.
  • From the log of an exclusive cluster, you can only obtain the last 100 access records of the cluster, evenly from all nodes of the cluster.
  • Access logs of exclusive clusters whose versions are earlier than 3.1.2 cannot be queried by filter.
  • Shared edition
    • Request date: View logs of a specified date.
    • Time range: View logs of a specified time range.
    • Request duration: Filter logs by request duration.
    • Advanced search: Filter logs by request ID, API name, app name, or status code.
  • Exclusive edition:
    • Cluster name: Query node logs of different clusters.
    • Start time-end time: You can query logs of the last 15 minutes, last 30 minutes, last 1 hour, last 4 hours, last 12 hours, last 24 hours, or last 3 days, or a custom time period.
    • Request duration: Filter logs by request duration.
    • Advanced search: Filter logs by request ID, API name, app name, or status code.