event, event center, event management-API Gateway(API Gateway)-阿里云帮助中心

Cloud-native API Gateway provides unified management, analysis, display, and notification of event data. You can use events to track resource changes and troubleshoot abnormal events with built-in guidance.

Event model

A Cloud-native API Gateway event has the following parameters.

Parameter	Description
Time	The time the event occurred.
Product Name	Cloud-native API Gateway
Event Name	The name of the event. It includes an event code and an event description.
Event Level	The Event Hub in Cloud-native API Gateway classifies events into three levels based on their impact. Information (INFO): Normal system operation. These events indicate expected behavior and do not affect your business. Warning (WARN): The system is running normally or can automatically recover. These events may affect your business and require attention. Critical (CRITICAL): The system has an issue and cannot automatically recover. These events prevent your business from running correctly.
Region	The instance's region.
Resource	The Alibaba Cloud Resource Name (ARN) of the affected resource.
Contents	The details of the event.
Actions	View the event details.

Entry point

Log on to the API Gateway console.
In the left navigation pane, select event.

Event query

The Event Center supports querying events by various criteria, such as:

Event level
Event name
Keyword
Event time

Query by event level

Filter events by their severity level.

The event levels are Critical, Warning, and Information.

Query by event name

Filter events by their name.

The event list includes the Event time, Event name, and Event level columns.

Query by keyword

Filter events by keyword. For example, to find events for the gateway instance gw-ctbq4qum1hknl20trv40d, enter gw-ctbq4qum1hknl20trv40 in the search box.

Note

You can find keywords in the Resource and Contents columns of the list.

Query by event time

Query events within a custom time range.

Note

In the Cloud Native API Gateway Event Center, you can query events from the last 90 days. The maximum time range for a single query is three consecutive days.

View event details

In the Actions column, click Details to view an event's details.

Event

The following scenarios and operations generate event notifications:

Cloud-native API Gateway auto scale-out (APIG:ElasticScaleOut)

During an auto scale-out, Cloud-native API Gateway generates an event that reflects the operation status.

Executing: In progress | Executed: Succeeded | Failed: Failed

`Executing`

The auto scale-out operation is in progress.

JSON format:

{
    "Status": "Executing",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:1321*******4629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01",
        "message": "Auto scale-out started.",
        "operator": "SYSTEM",
        "publishRecordId": 6264487,
        "replicas": 3
    },
    "Product": "cnapigateway",
    "Time": 1756400523000,
    "Level": "INFO",
    "RegionId": "cn-hangzhou",
    "Id": "f41bb19f-c0ae-4938-b182-13b3cead0322",
    "GroupId": "0",
    "Name": "APIG:ElasticScaleOut:Executing"
}

`Executed`

The auto scale-out operation succeeded.

JSON format:

{
    "Status": "Executed",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:1321****094629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01",
        "message": "Auto scale-out succeeded.",
        "operator": "SYSTEM",
        "publishRecordId": 6264487,
        "replicas": 3
    },
    "Product": "cnapigateway",
    "Time": 1756400539000,
    "Level": "INFO",
    "RegionId": "cn-hangzhou",
    "Id": "3f70b85e-ed52-4d20-b97e-6bcc35588114",
    "GroupId": "0",
    "Name": "APIG:ElasticScaleOut:Executed"
}

`Failed`

The auto scale-out operation failed.

JSON format:

{
    "Status": "Failed",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:13219*****94629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01",
        "message": "Auto scale-out failed.",
        "operator": "SYSTEM",
        "publishRecordId": 6264487,
        "replicas": 3
    },
    "Product": "cnapigateway",
    "Time": 1756400539000,
    "Level": "WARN",
    "RegionId": "cn-hangzhou",
    "Id": "3f70b85e-ed52-4d20-b97e-6bcc35588114",
    "GroupId": "0",
    "Name": "APIG:ElasticScaleOut:Failed"
}

The Content object contains the following fields.

Parameter	Description	Example
gatewayName	The gateway name.	gw-test-01
replicas	The number of gateway instance nodes after the scale-out.	3
message	The event message.	Auto scale-out succeeded.
gatewayId	The unique ID of the gateway.	gw-d2o34q6m1hkgipd1hph0
operator	The entity that triggered the event.	SYSTEM
publishRecordId	The ID of the publish record.	6264487

Cloud-native API Gateway auto scale-in (APIG:ElasticScaleIn)

During an auto scale-in, Cloud-native API Gateway generates an event with three possible states:

Executing: In progress | Executed: Succeeded | Failed: Failed

`Executing`

The auto scale-in operation is in progress.

JSON format:

{
    "Status": "Executing",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:132******94629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01",
        "message": "Auto scale-in started",
        "operator": "SYSTEM",
        "publishRecordId": 6266557,
        "replicas": 2
    },
    "Product": "cnapigateway",
    "Time": 1756414922000,
    "Level": "INFO",
    "RegionId": "cn-hangzhou",
    "Id": "7bb39402-08ff-4f1f-b3d1-2d259ee4711d",
    "GroupId": "0",
    "Name": "APIG:ElasticScaleIn:Executing"
}

`Executed`

The auto scale-in operation has succeeded.

JSON format:

{
    "Status": "Executed",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:132******94629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01",
        "message": "Auto scale-in succeeded",
        "operator": "SYSTEM",
        "publishRecordId": 6266557,
        "replicas": 2
    },
    "Product": "cnapigateway",
    "Time": 1756414922000,
    "Level": "INFO",
    "RegionId": "cn-hangzhou",
    "Id": "7bb39402-08ff-4f1f-b3d1-2d259ee4711d",
    "GroupId": "0",
    "Name": "APIG:ElasticScaleIn:Executed"
}

`Failed`

The auto scale-in operation has failed.

JSON format:

{
    "Status": "Failed",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:132******94629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01",
        "message": "Auto scale-in failed",
        "operator": "SYSTEM",
        "publishRecordId": 6266557,
        "replicas": 2
    },
    "Product": "cnapigateway",
    "Time": 1756414922000,
    "Level": "WARN",
    "RegionId": "cn-hangzhou",
    "Id": "7bb39402-08ff-4f1f-b3d1-2d259ee4711d",
    "GroupId": "0",
    "Name": "APIG:ElasticScaleIn:Failed"
}

The following table describes the fields in the Content object.

Parameter	Description	Example value
gatewayName	The gateway name.	gw-test-01
replicas	The number of gateway instances.	2
message	The event message.	Auto scale-in succeeded
gatewayId	The gateway ID.	gw-d2o34q6m1hkgipd1hph0
operator	The entity that triggered the event.	SYSTEM
publishRecordId	The publish record ID.	6266557

Cloud-native API Gateway auto scaling (APIG:ElasticOpen)

When you enable auto scaling, Cloud-native API Gateway generates an event that indicates the result:

Executed: Success | Failed: Failure

`Executed`

Auto scaling was enabled for the Cloud-native API Gateway instance.

JSON format:

{
    "Status": "Executed",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:13219******4629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "message": "Create Elastic Strategy:Success",
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01",
        "newElasticStrategy": {
            "elasticEnabled": true,
            "elasticType": "CronHPA",
            "timePolicyList": [
                {
                    "units": 3,
                    "startTime": "01:02",
                    "endTime": "05:02"
                }
            ],
            "maxUnits": null,
            "loadWarningThreshold": null,
            "enableScaleTimePolicyList": [
                {
                    "startTime": "",
                    "endTime": ""
                }
            ],
            "disableScaleTimePolicyList": null
        }
    },
    "Product": "cnapigateway",
    "Time": 1756378065000,
    "Level": "INFO",
    "RegionId": "cn-hangzhou",
    "Id": "589abc6e-97de-4d3d-b580-7fe53cda6feb",
    "GroupId": "0",
    "Name": "APIG:ElasticOpen:Executed"
}

`Failed`

Enabling auto scaling for the Cloud-native API Gateway instance failed.

JSON format:

{
    "Status": "Failed",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:13219******4629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "message": "Create Elastic Strategy:Failed",
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01"
    },
    "Product": "cnapigateway",
    "Time": 1756378065000,
    "Level": "WARN",
    "RegionId": "cn-hangzhou",
    "Id": "589abc6e-97de-4d3d-b580-7fe53cda6feb",
    "GroupId": "0",
    "Name": "APIG:ElasticOpen:Failed"
}

The following table describes the fields in the Content object.

Parameter	Description	Example
message	The log message.	Create Elastic Strategy:Success
gatewayId	The gateway ID.	gw-d2o34q6m1hkgipd1hph0
gatewayName	The gateway name.	gw-test-01
newElasticStrategy	The new scaling policy.
elasticEnabled	Indicates whether auto scaling is enabled.	true
elasticType	The scaling method.	CronHPA
units	The target number of nodes.	3
startTime	The policy execution start time.	01:02
endTime	The policy execution end time.	05:02
maxUnits	The maximum number of nodes.	null
loadWarningThreshold	The scaling threshold.	null
disableScaleTimePolicyList	The time periods when scale-in is disallowed.	null

Disabling auto scaling for Cloud-native API Gateway (APIG:ElasticClose)

When you disable auto scaling, Cloud-native API Gateway generates an event that indicates the result:

Executed: Succeeded | Failed: Failed

`Executed`

Auto scaling was disabled for the instance.

JSON format:

{
    "Status": "Executed",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:132*******629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "message": "Delete Elastic Strategy:Success",
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01",
        "oldElasticStrategy": {
            "elasticEnabled": true,
            "elasticType": "CronHPA",
            "timePolicyList": [
                {
                    "units": 3,
                    "startTime": "05:04",
                    "endTime": "08:04"
                }
            ],
            "maxUnits": null,
            "loadWarningThreshold": null,
            "enableScaleTimePolicyList": [
                {
                    "startTime": "",
                    "endTime": ""
                }
            ],
            "disableScaleTimePolicyList": null
        }
    },
    "Product": "cnapigateway",
    "Time": 1756430305000,
    "Level": "INFO",
    "RegionId": "cn-hangzhou",
    "Id": "6305f83d-3735-4c5c-aa41-ec1353af7d60",
    "GroupId": "0",
    "Name": "APIG:ElasticClose:Executed"
}

`Failed`

Disabling auto scaling for the instance failed.

JSON format:

{
    "Status": "Failed",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:13219******4629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "message": "Delete Elastic Strategy:Failed",
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01"
    },
    "Product": "cnapigateway",
    "Time": 1756378065000,
    "Level": "WARN",
    "RegionId": "cn-hangzhou",
    "Id": "589abc6e-97de-4d3d-b580-7fe53cda6feb",
    "GroupId": "0",
    "Name": "APIG:ElasticClose:Failed"
}

The following table describes the fields in the Content object.

Parameter	Description	Example value
message	The log message.	Delete Elastic Strategy:Success
gatewayId	The gateway ID.	gw-d2o34q6m1hkgipd1hph0
gatewayName	The gateway name.	gw-test-01
oldElasticStrategy	The previous auto scaling policy configuration.
elasticEnabled	Indicates whether auto scaling was enabled.	true
elasticType	The scaling method.	CronHPA
units	The target number of nodes.	3
startTime	The policy start time.	05:04
endTime	The policy end time.	08:04
maxUnits	The maximum number of nodes allowed.	4
loadWarningThreshold	The load threshold that triggers a scaling action.	true
disableScaleTimePolicyList	The time periods when scale-in is disallowed.	null

Auto scaling policy update (APIG:ElasticStrategyUpdate)

When auto scaling is enabled, Cloud-native API Gateway generates this event to report the result of a scaling policy update.

Executed: Succeeded | Failed: Unsuccessful

`Executed`

The auto scaling policy was updated.

JSON format:

{
    "Status": "Executed",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:1321*****4629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "message": "Update Elastic Strategy:Success",
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01",
        "oldElasticStrategy": {
            "elasticEnabled": true,
            "elasticType": "CronHPA",
            "timePolicyList": [
                {
                    "units": 3,
                    "startTime": "01:02",
                    "endTime": "05:02"
                }
            ],
            "maxUnits": null,
            "loadWarningThreshold": null,
            "enableScaleTimePolicyList": [
                {
                    "startTime": "",
                    "endTime": ""
                }
            ],
            "disableScaleTimePolicyList": null
        },
        "newElasticStrategy": {
            "elasticEnabled": true,
            "elasticType": "CronHPA",
            "timePolicyList": [
                {
                    "units": 3,
                    "startTime": "05:04",
                    "endTime": "08:04"
                }
            ],
            "maxUnits": null,
            "loadWarningThreshold": null,
            "enableScaleTimePolicyList": [
                {
                    "startTime": "",
                    "endTime": ""
                }
            ],
            "disableScaleTimePolicyList": null
        }
    },
    "Product": "cnapigateway",
    "Time": 1756430007000,
    "Level": "INFO",
    "RegionId": "cn-hangzhou",
    "Id": "ee78f750-1f3a-45d7-8c4f-cc17d6ae5f75",
    "GroupId": "0",
    "Name": "APIG:ElasticStrategyUpdate:Executed"
}

`Failed`

The auto scaling policy update failed.

JSON format:

{
    "Status": "Failed",
    "InstanceName": "gw-test-01",
    "ResourceId": "acs:apig:cn-hangzhou:13219******4629:gateway/gw-d2o34q6m1hkgipd1hph0",
    "Content": {
        "message": "Update Elastic Strategy:Failed",
        "gatewayId": "gw-d2o34q6m1hkgipd1hph0",
        "gatewayName": "gw-test-01"
    },
    "Product": "cnapigateway",
    "Time": 1756378065000,
    "Level": "WARN",
    "RegionId": "cn-hangzhou",
    "Id": "589abc6e-97de-4d3d-b580-7fe53cda6feb",
    "GroupId": "0",
    "Name": "APIG:ElasticStrategyUpdate:Failed"
}

The following table describes the fields in the content object.

Parameter	Description	Example
message	The log message.	Update Elastic Strategy:Success
gatewayId	The gateway ID.	gw-d2o34q6m1hkgipd1hph0
gatewayName	The gateway name.	gw-test-01
oldElasticStrategy	The policy configuration before the update.
newElasticStrategy	The policy configuration after the update.
elasticEnabled	Indicates whether auto scaling is enabled.	true
elasticType	The scaling method.	CronHPA
units	The target number of nodes for the policy.	3
startTime	The policy execution start time.	05:04
endTime	The policy execution end time.	08:04
maxUnits	The maximum number of nodes.	4
loadWarningThreshold	The scaling threshold.	true
disableScaleTimePolicyList	Periods when scale-in is disabled.	null

The following table lists all Cloud-native API Gateway events and their recommended actions.

Event code	Event name	Event level	Cloud Monitor event name	Description
APIG:ElasticScaleOut	Elastic scale-out of a cloud-native API gateway	Warning	APIG:ElasticScaleOut:Failed: The cloud-native API gateway failed to scale out.	This event indicates the status of an elastic scale-out operation.
		INFO	APIG:ElasticScaleOut:Executing: The cloud-native API gateway is scaling out.
		INFO	APIG:ElasticScaleOut:Executed: The cloud-native API gateway successfully scaled out.
APIG:ElasticScaleIn	Elastic scale-in of a cloud-native API gateway	Warning	APIG:ElasticScaleIn:Failed: The cloud-native API gateway failed to scale in.	This event indicates the status of an elastic scale-in operation.
		INFO	APIG:ElasticScaleIn:Executing: The cloud-native API gateway is scaling in.
		INFO	APIG:ElasticScaleIn:Executed: The cloud-native API gateway successfully scaled in.
APIG:ElasticOpen	Enabling elastic scaling for a cloud-native API gateway	Warning	APIG:ElasticOpen:Failed: Failed to enable elastic scaling for the cloud-native API gateway.	This event indicates the result of enabling elastic scaling.
		INFO	APIG:ElasticOpen:Executed: Elastic scaling was successfully enabled for the cloud-native API gateway.
APIG:ElasticClose	Disabling elastic scaling for a cloud-native API gateway	Warning	APIG:ElasticClose:Failed: Failed to disable elastic scaling for the cloud-native API gateway.	This event indicates the result of disabling elastic scaling.
		INFO	APIG:ElasticClose:Executed: Elastic scaling was successfully disabled for the cloud-native API gateway.
APIG:ElasticStrategyUpdate	Updating the elastic scaling policy for a cloud-native API gateway	Warning	APIG:ElasticStrategyUpdate:Failed: Failed to update the elastic scaling policy for the cloud-native API gateway.	When elastic scaling is enabled, this event indicates the result of updating the elastic scaling policy.
		INFO	APIG:ElasticStrategyUpdate:Executed: The elastic scaling policy for the cloud-native API gateway was successfully updated.