API details

更新时间:
复制 MD 格式

The API Details page displays key metrics for all APIs in your application, including passed QPS, blocked QPS, exception QPS, RT, and concurrency. It also provides tools to manage flow control rules for gateway APIs.

Procedure

  1. Log on to the AHAS Console and select a region in the upper-left corner.

  2. In the left-side navigation pane, choose Traffic Protection > Gateway Flow Control.

  3. On the Gateway Flow Control page, click the card for the target application.

  4. In the left-side navigation pane, choose API Details.

Features

The API Details page provides a comprehensive overview of all gateway APIs, showing key metrics like QPS, RT, and concurrency at a glance.

接口详情

The following features are also available on this page:

  • (Icon ①) In the upper-right corner of the page, select a display mode. The default mode is details view.
    • Details view: Displays API metrics such as passed QPS, blocked QPS, and RT in time series charts and time series lists.
    • Statistics view: Displays a list of daily API metrics, such as metric proportions, total passed requests, and total blocked requests.
  • (Icon ②) In the upper-right corner of the page, you can select a playback time to view historical API data.
    Note Advanced Protection stores up to 7 days of historical data, while Basic Protection stores only 30 minutes.
  • (Icon ③) In the API list area, click an API name to view its time series charts for QPS, RT, and concurrency; protection events; and traffic distribution across different nodes.
  • (Icon ④) In the time series chart area, you can select which metrics to show or hide, and choose how the API metrics are displayed.
    • Card mode: Displays metrics for each API on a separate card.
    • Overview mode: Displays API data organized by statistical dimensions such as QPS, RT, and concurrency.
    Note You can only switch between modes when viewing all APIs.
  • (Icon ⑤) In the time series chart area, you can also configure flow control rules and access other options for each API.
    • Click the 添加至大盘.png icon to add the API to the Traffic Dashboard. This lets you monitor system-wide traffic on the Traffic Dashboard. For more information, see Create Traffic Dashboard.
    • Click the 管理规则 or 新增 icon to open the Manage Rules dialog box. In this dialog, you can add, delete, edit, enable, or disable flow control rules. For more information, see API flow control rules.
    • Click the 历史记录 icon to view historical data for the API's metrics.
      Note Advanced Protection stores up to 7 days of historical data, while Basic Protection stores only 30 minutes.