摘要 API 事件记录字段参考

与单个事件记录相比，API 事件摘要记录的保留时间更长。

摘要 API 事件记录字段

表 1 显示了存储在摘要 API 事件记录中的字段示例。

表 1. API 事件记录字段
字段名称	类型	描述
api_ref	字符串	应用程序接口引用（api_name:api_version）
app_name	字符串	已注册的应用程序的名称。注：当未使用客户端 ID 或该 ID 在 API 上无效时，该属性将被设置为 `undefined` 。网关需要客户机标识来确定哪个应用程序在调用 API。网关可从此应用程序确定应用程序在包含 API 的产品上预订的计划。没有客户 ID，网关就无法确定调用的是哪个计划、产品或应用程序。这是因为单个 API 可以属于多个产品，而每个产品都有多个计划和应用程序，这些应用程序通过客户端 ID 订阅这些计划。
bytes_received	数量	请求中从消费者处接收到的字节数。
bytes_sent	数量	响应中发送给消费者的字节数。
catalog_name	字符串	目录的名称
日期时间	日期	记录 API 调用时间的时间戳。时间戳始终以协调世界时显示。
developer_org_name	字符串	拥有该应用程序的使用者组织的名称。
网关服务名称	字符串	DataPower® API 网关服务的名称。由云管理员在网关服务注册时配置。仅适用于 DataPower API Gateway v10.5.3 或更高版本。
org_name	字符串	拥有该 API 和关联产品的提供者组织的名称。
plan_id	字符串	计划标识。
产品参考	字符串	产品参考信息（product_name:product_version）
space_name	字符串	发布到空间的产品的空间名称
status_code	字符串	出站响应设置的状态码。
事件摘要 ID	字符串	分配给事件的唯一 ID
time_to_serve_request	数量	从网关收到请求到发出响应所经过的时间（以毫秒为单位

事件简要记录示例

{
            "api_ref": "switch-api:1.0.0",
            "app_name": "api-connect-app-4",
            "bytes_received": 888,
            "bytes_sent": 9177,
            "catalog_name": "api-connect-catalog-1",
            "datetime": "2025-06-11T04:00:00.000Z",
            "developer_org_name": "api-connect-emard-greenholt-awesome-fantastic-soft-sausages-consumer-organization",
            "gateway_service_name": "v6gw",
            "org_name": "ibm",
            "plan_id": "api-connect-crooks-group-luxurious-tasty-rubber-chair-product:1.0.0:default-plan",
            "product_ref": "api-connect-crooks-group-luxurious-tasty-rubber-chair-product:1.0.0",
            "space_name": null,
            "status_code": "201 Created",
            "summary_event_id": "A11ybP3Dnla5jttwIQuGjA",
            "time_to_serve_request": 571
        }

使用以下操作，通过 API Connect Analytics REST API 检索分析摘要事件数据：

表 2. 用于检索分析摘要事件数据的操作
操作	描述
GET /summary	此操作将返回事件记录摘要列表。
GET /summary/:id	此操作根据唯一 ID 返回特定事件摘要记录。
GET /summary/count	此操作将返回事件摘要记录的总数。

注：这些操作也出现在工具包的分析 CLI 中。