Help Center/ Config/ User Guide/ Resource Compliance/ Built-In Policies/ API Gateway/ Dedicated API Gateways Have Logging Enabled
Updated on 2025-08-25 GMT+08:00
View PDF
Share

Dedicated API Gateways Have Logging Enabled

Rule Details

Table 1 Rule details

Parameter

Description

Rule Name

apig-instances-execution-logging-enabled

Identifier

Dedicated API Gateways Have Logging Enabled

Description

If logging is not enabled for a dedicated API gateway, this instance is non-compliant.

Tag

apig

Trigger Type

Configuration change

Filter Type

apig.instances

Rule Parameters

None

Application Scenarios

APIG provides visualized analysis and statistics of APIs, allowing you to view API call logs. You will have the following benefits using APIG:

  • Abnormal access detection: Audit logs allow you to identify abnormal access events, such as frequent failed requests and requests from abnormal IP addresses, and detect potential attacks.
  • Easy troubleshooting: The cause of API call failures, such as parameter errors and service unavailability, can be quickly located with the logs.
  • User behavior analysis: You can understand user behavior and optimize your product by analyzing API call patterns.
  • Resource usage monitoring: You can have a clear vew of the API call frequency and resource consumption and take actions to prevent resource waste.

Solution

Enable logging, and configure log management and log dump. For details, see Viewing API Call Logs.

Rule Logic

  • If logging is not enabled for a dedicated API gateway, this instance is non-compliant.
  • If logging is enabled for a dedicated API gateway, this instance is compliant.
Parent topic: API Gateway