event, event hub, event management - API Gateway - Alibaba Cloud Documentation Center

Cloud-native API Gateway lets you centrally manage, analyze, view, and be notified about events. You can troubleshoot exceptions using the event data as instructed in the Cloud-native API Gateway console. This topic describes how to manage Cloud-native API Gateway events to learn about changes to your managed resources.

Event model

The Event page in the Cloud-native API Gateway console shows events based on the following parameters:

Parameter	Description
Time	The time when the event was triggered.
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): The system is running normally. The event indicates expected behavior that does not affect your business. Warning (WARN): The system is running normally or can automatically recover from an issue. The event may affect your business and requires your attention. Critical (CRITICAL): The system has an issue and cannot automatically recover. This prevents your business from functioning correctly.
Region	The region where the instance is located.
Resource	The Alibaba Cloud Resource Name (ARN) of the resource associated with the event.
Contents	The details of the event.
Actions	View the event details.

Entry point

Log on to the API Gateway console.
In the navigation pane on the left, click Event.

Query events

On the Event page, you can query events from multiple dimensions. For example, you can query events by:

Event level
Event Name
Resource and content keyword
Time

Query events by event level

You can specify an event level to filter events.

Query events by event name

You can specify an event name to filter events.

Query events by keyword

You can specify a keyword contained in the related resource or in the event content to filter events. Example: to query events related to an instance whose ID is gw-ctbq4qum1hknl20trv40d, enter gw-ctbq4qum1hknl20trv40d in the search box.

Note

You can enter a keyword based on the information provided in the Resource and Contents column in the list.

Query events by time

You can specify a time range to query the events that are generated within the specified time range.

Note

You can query data within the last 90 days, with a maximum of three consecutive days per query.

View event details

Find the event whose details you want to view, and click Details in the Actions column.

Event description

The following scenarios and operations trigger event notifications:

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

When an auto scale-out operation occurs, Cloud-native API Gateway generates an event that indicates the status of the operation. The event can have one of the following three statuses:

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

`Executing`

This status indicates that 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`

This status indicates that 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`

This status indicates that 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 following table describes the fields in the event content.

Field	Description	Example value
gatewayName	Gateway name	gw-test-01
replicas	Number of gateway instance nodes	3
message	Message	Auto scale-out succeeded
gatewayId	Gateway ID	gw-d2o34q6m1hkgipd1hph0
operator	Event executor	SYSTEM
publishRecordId	Publish record ID	6264487

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

When an auto scale-in operation occurs, Cloud-native API Gateway generates an event that indicates the status of the operation. The event can have one of the following three statuses:

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

`Executing`

This status indicates that 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`

This status indicates that the auto scale-in operation 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`

This status indicates that the auto scale-in operation 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 event content.

Field	Description	Example value
gatewayName	Gateway name	gw-test-01
replicas	Number of gateway instance nodes	3
message	Message	Auto scale-in succeeded
gatewayId	Gateway ID	gw-d2o34q6m1hkgipd1hph0
operator	Event executor	SYSTEM
publishRecordId	Publish record ID	6264487

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

When you enable auto scaling, Cloud-native API Gateway generates an event that indicates the result. The event can have one of the following two statuses:

Executed: Succeeded | Failed: Failed

`Executed`

This status indicates that auto scaling was successfully enabled for the cloud-native API gateway.

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`

This status indicates that the attempt to enable auto scaling for the cloud-native API gateway 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 event content.

Field	Description	Example value
message	Log message	Create Elastic Strategy:Success
gatewayId	Gateway ID	gw-d2o34q6m1hkgipd1hph0
gatewayName	Gateway name	gw-test-01
newElasticStrategy	New policy
elasticEnabled	Auto scaling enabled	true
elasticType	Scaling method	CronHPA
units	Target total nodes	3
startTime	Policy execution start time	01:02
endTime	Policy execution end time	05:02
maxUnits	Maximum number of nodes allowed	4
loadWarningThreshold	Scaling watermark setting	true
disableScaleTimePolicyList	Time periods when scale-in is allowed	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. The event can have one of the following two statuses:

Executed: Succeeded | Failed: Failed

`Executed`

This status indicates that auto scaling was successfully disabled for the cloud-native API gateway.

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`

This status indicates that the attempt to disable auto scaling for the cloud-native API gateway 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 event content.

Field	Description	Example value
message	Log message	Delete Elastic Strategy:Success
gatewayId	Gateway ID	gw-d2o34q6m1hkgipd1hph0
gatewayName	Gateway name	gw-test-01
oldElasticStrategy	Old policy
elasticEnabled	Auto scaling enabled	true
elasticType	Scaling method	CronHPA
units	Target total nodes	3
startTime	Policy execution start time	05:04
endTime	Policy execution end time	08:04
maxUnits	Maximum number of nodes allowed	4
loadWarningThreshold	Scaling watermark setting	true
disableScaleTimePolicyList	Time periods when scale-in is allowed	null

Updating the auto scaling policy for Cloud-native API Gateway (APIG:ElasticStrategyUpdate)

If auto scaling is enabled, Cloud-native API Gateway generates an event that indicates the result of a policy update. The event can have one of the following two statuses:

Executed: Succeeded | Failed: Failed

`Executed`

This status indicates that the auto scaling policy for the cloud-native API gateway was successfully 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`

This status indicates that the attempt to update the auto scaling policy for the cloud-native API gateway 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 event content.

Field	Description	Example value
message	Log message	Update Elastic Strategy:Success
gatewayId	Gateway ID	gw-d2o34q6m1hkgipd1hph0
gatewayName	Gateway name	gw-test-01
oldElasticStrategy	Old policy
newElasticStrategy	New policy
elasticEnabled	Auto scaling enabled	true
elasticType	Scaling method	CronHPA
units	Target total nodes	3
startTime	Policy execution start time	05:04
endTime	Policy execution end time	08:04
maxUnits	Maximum number of nodes allowed	4
loadWarningThreshold	Scaling watermark setting	true
disableScaleTimePolicyList	Time periods when scale-in is allowed	null

The following table describes all events that Cloud-native API Gateway supports and provides suggestions for handling each event.

Event code	Event name	Event level	Cloud Monitor event name	Event description and impact
APIG:ElasticScaleOut	Elastic scale-out of a cloud-native API gateway	WARN	APIG:ElasticScaleOut:Failed: The cloud-native API gateway failed to scale out.	A cloud-native API gateway generates this event based on the status of a 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	WARN	APIG:ElasticScaleIn:Failed: The cloud-native API gateway failed to scale in.	A cloud-native API gateway generates this event based on the status of a 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	WARN	APIG:ElasticOpen:Failed: Failed to enable elastic scaling for the cloud-native API gateway.	A cloud-native API gateway generates this event based on the result of an operation to enable 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	WARN	APIG:ElasticClose:Failed: Failed to disable elastic scaling for the cloud-native API gateway.	A cloud-native API gateway generates this event based on the result of an operation to disable 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	WARN	APIG:ElasticStrategyUpdate:Failed: Failed to update the elastic scaling policy for the cloud-native API gateway.	A cloud-native API gateway generates this event based on the result of an update to the elastic scaling policy.
		INFO	APIG:ElasticStrategyUpdate:Executed: The elastic scaling policy for the cloud-native API gateway was successfully updated.