您正在查看 Apigee Edge 文档。
转到 Apigee X 文档。 信息
使用 /metrics/events API 可获取组织在指定时间间隔内的所有事件。 事件列表包含 Edge 检测到的所有提醒。
默认情况下,该 API 会返回前一小时的所有事件。
使用 from
和 to
查询参数指定不同的时长。from
和 to
查询参数值支持以下格式:
now
(当前的当地时间)-<value><unit>
指定过去的时间(请注意前导连字符):<value>
- 一个整数<unit>
- 时间单位:s, sec, second, m, min, minute, h, hr, hour, d, day
- ISO 格式的日期,格式为:
yyyy-mm-ddThh:mm:ssZ
yyyy-mm-ddThh:mm:ss+00:00
例如:
now
- -
1h
-10min
2019-05-13T14:04:00+00:00
只有 org
查询参数是必需的。以下 API 调用会返回组织 myorg
中过去 12 小时内的所有事件:
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ "https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&from=-12h&to=now"
将 $ACCESS_TOKEN
设置为 OAuth 2.0 访问令牌,如获取 OAuth 2.0 访问令牌中所述。如需了解此示例中使用的 curl
选项,请参阅使用 curl。
此 API 支持以下可选的查询参数:
名称 | 说明 | 默认 |
---|---|---|
from
|
应提取提醒的时间间隔的起始值。默认值为当前时间减去 1 小时。请参阅上文中的说明,了解如何设置此参数。 | -1 小时 |
to
|
应提取提醒的时间间隔的结束时间。默认值为当前时间。请参阅上文中的说明,了解如何设置此参数。 | 现在 |
alertId
|
按指定的提醒定义 ID 过滤提醒历史记录结果。 | 所有提醒 ID |
env
|
按指定的环境过滤事件。 | 所有环境 |
name
|
按指定的提醒名称过滤事件。 | 所有提醒名称 |
region
|
按指定区域过滤事件。 | 所有区域 |
type
|
按指定的类型过滤事件:alert 。
|
所有类型 |