事件管理

云原生API网关为生成的事件数据提供了统一的管理、分析、展示和通知能力。针对一些异常事件,您可以根据云原生API网关提供的指引自主排查。本文介绍如何通过事件感知云原生API网关所托管资源的事件变更。

事件模型

一个云原生API网关事件主要有以下参数定义。

参数

描述

时间

事件的触发时间。

产品名称

cnapigateway

事件名称

事件的名称,包含事件Code和事件描述两部分。

事件等级

云原生API网关事件中心按事件的影响程度将其划分成了三个等级。

  • 信息(INFO)系统运行正常,用户预期行为对业务没有影响的事件。

  • 警告(WARN)系统运行正常或出现异常可自愈,对业务可能有影响需要用户关注的事件。

  • 严重(CRITICAL)系统运行异常无法自愈,导致业务无法正常工作的事件。

地域

实例所在region。

资源

事件关联的资源ARN。

内容

事件具体内容。

操作

查看事件详情。

功能入口

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,选择事件

事件查询

事件中心提供了多维度的事件查询能力,您可以按照多个维度进行事件查询。例如:

  • 事件等级

  • 事件名称

  • 关键字

  • 事件触发时间

按事件等级查询

您可以选择指定的事件等级进行事件筛选。

image

按事件名称查询

您可以选择指定的事件名称进行事件筛选。

image

按关键字查询

可以输入关键字进行事件筛选。例如:如果您需要查询网关实例gw-ctbq4qum1hknl20trv40d的关联事件,可以在搜索框中输入gw-ctbq4qum1hknl20trv40查询。

说明

关键字请在列表中的资源内容中获取。

按事件触发时间查询

自定义时间范围,您可以便捷地查询指定时间段内所触发的事件。

说明

云原生API网关事件中心可查询90天内的数据,最多连续查询3天数据。

查看事件详情

单击事件记录操作列的详情,您可以查看事件的详细信息。

image

事件说明

以下场景或者操作会触发相关事件通知:

云原生API网关弹性扩容(APIG:ElasticScaleOut

执行弹性扩容时,云原生API网关会根据扩容所处的状态产生此事件,共有三个状态:

Executing:执行中|Executed:执行成功|Failed:执行失败

Executing

该状态代表云原生API网关弹性扩容进行中。

JSON格式:

{
    "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": "弹性扩容开始",
        "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

该状态代表云原生API网关弹性扩容执行成功。

JSON格式:

{
    "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": "弹性扩容成功",
        "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

该状态代表云原生API网关弹性扩容执行失败。

JSON格式:

{
    "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": "弹性扩容失败",
        "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"
}

content(内容)字段解释:

字段

说明

示例值

gatewayName

网关名称

gw-test-01

replicas

网关实例节点数

3

message

消息

弹性扩容成功

gatewayId

网关 ID

gw-d2o34q6m1hkgipd1hph0

operator

事件的执行者

SYSTEM

publishRecordId

发布记录ID

6264487

云原生API网关弹性缩容(APIG:ElasticScaleIn

执行弹性缩容时,云原生API网关会根据缩容所处的状态产生此事件,共有三个状态:

Executing:执行中|Executed:执行成功|Failed:执行失败

Executing

该状态代表云原生API网关弹性缩容执行中。

JSON格式:

{
    "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": "弹性缩容开始",
        "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

该状态代表云原生API网关弹性缩容成功。

JSON格式:

{
    "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": "弹性缩容成功",
        "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

该状态代表云原生API网关弹性缩容失败。

JSON格式:

{
    "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": "弹性缩容失败",
        "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"
}

content(内容)字段解释:

字段

说明

示例值

gatewayName

网关名称

gw-test-01

replicas

网关实例节点数

3

message

消息

弹性缩容成功

gatewayId

网关 ID

gw-d2o34q6m1hkgipd1hph0

operator

事件的执行者

SYSTEM

publishRecordId

发布记录ID

6264487

云原生API网关弹性开启(APIG:ElasticOpen

开启自动扩容时,云原生API网关会根据开启结果产生此事件,共有两个状态:

Executed:成功|Failed:失败

Executed

该状态代表云原生API网关弹性开启成功。

JSON格式:

{
    "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

该状态代表云原生API网关弹性开启失败。

JSON格式:

{
    "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"
}

content(内容)字段解释:

字段

说明

示例值

message

日志信息

Create Elastic Strategy:Success

gatewayId

网关ID

gw-d2o34q6m1hkgipd1hph0

gatewayName

网关名称

gw-test-01

newElasticStrategy

新版策略

elasticEnabled

弹性开启

true

elasticType

扩缩容方式

CronHPA

units

目标总节点

3

startTime

策略执行开始时间

01:02

endTime

策略执行结束时间

05:02

maxUnits

允许最大节点数

4

loadWarningThreshold

扩缩容水位设置

true

disableScaleTimePolicyList

允许缩容的时间段

null

云原生API网关弹性关闭(APIG:ElasticClose

关闭自动扩容时,云原生API网关会根据关闭结果产生此事件,共有两个状态:

Executed:成功|Failed:失败

Executed

该状态代表云原生API网关弹性关闭成功。

JSON格式:

{
    "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

该状态代表云原生API网关弹性关闭失败。

JSON格式:

{
    "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"
}

content(内容)字段解释:

字段

说明

示例值

message

日志信息

Delete Elastic Strategy:Success

gatewayId

网关ID

gw-d2o34q6m1hkgipd1hph0

gatewayName

网关名称

gw-test-01

oldElasticStrategy

旧策略

elasticEnabled

弹性开启

true

elasticType

扩缩容方式

CronHPA

units

目标总节点

3

startTime

策略执行开始时间

05:04

endTime

策略执行结束时间

08:04

maxUnits

允许最大节点数

4

loadWarningThreshold

扩缩容水位设置

true

disableScaleTimePolicyList

允许缩容的时间段

null

云原生API网关弹性策略更新)(APIG:ElasticStrategyUpdate

自动扩容处于开启状态时,云原生API网关会更新自动扩容策略,并根据更新结果产生此事件,共有两个状态:

Executed:成功|Failed:失败

Executed

该状态代表云原生API网关弹性策略更新成功。

JSON格式:

{
    "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

该状态代表云原生API网关弹性策略更新失败。

JSON格式:

{
    "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"
}

content(内容)字段解释:

字段

说明

示例值

message

日志信息

Update Elastic Strategy:Success

gatewayId

网关ID

gw-d2o34q6m1hkgipd1hph0

gatewayName

网关名称

gw-test-01

oldElasticStrategy

旧策略

newElasticStrategy

新策略

elasticEnabled

弹性开启

true

elasticType

扩缩容方式

CronHPA

units

目标总节点

3

startTime

策略执行开始时间

05:04

endTime

策略执行结束时间

08:04

maxUnits

允许最大节点数

4

loadWarningThreshold

扩缩容水位设置

true

disableScaleTimePolicyList

允许缩容的时间段

null

关于云原生API网关支持的所有事件和为各事件提供处理建议,请参见下表:

事件Code

事件名称

事件等级

云监控事件名称

事件说明和影响

APIG:ElasticScaleOut

云原生API网关弹性扩容

警告

APIG:ElasticScaleOut:Failed:云原生API网关弹性扩容执行失败

执行弹性扩容时,云原生API网关会根据扩容所处的状态产生此事件。

信息

APIG:ElasticScaleOut:Executing:云原生API网关弹性扩容执行中

信息

APIG:ElasticScaleOut:Executed:云原生API网关弹性扩容执行成功

APIG:ElasticScaleIn

云原生API网关弹性缩容

警告

APIG:ElasticScaleIn:Failed:云原生API网关弹性缩容执行失败

执行弹性缩容时,云原生API网关会根据缩容所处的状态产生此事件。

信息

APIG:ElasticScaleIn:Executing:云原生API网关弹性缩容执行中

信息

APIG:ElasticScaleIn:Executed:云原生API网关弹性缩容执行成功

APIG:ElasticOpen

云原生API网关弹性开启

警告

APIG:ElasticOpen:Failed:云原生API网关弹性开启失败

开启自动扩容时,云原生API网关会根据开启结果产生此事件。

信息

APIG:ElasticOpen:Executed:云原生API网关弹性开启成功

APIG:ElasticClose

云原生API网关弹性关闭

警告

APIG:ElasticClose:Failed:云原生API网关弹性关闭失败

关闭自动扩容时,云原生API网关会根据关闭结果产生此事件。

信息

APIG:ElasticClose:Executed:云原生API网关弹性关闭成功

APIG:ElasticStrategyUpdate

云原生API网关弹性策略更新

警告

APIG:ElasticStrategyUpdate:Failed:云原生API网关弹性策略更新失败

自动扩容处于开启状态时,云原生API网关会更新自动扩容策略,并根据更新结果产生此事件。

信息

APIG:ElasticStrategyUpdate:Executed:云原生API网关弹性策略更新成功