您正在查看 Apigee Edge 文档。
转到
Apigee X 文档。 info
使用 /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:ssZyyyy-mm-ddThh:mm:ss+00:00
例如:
now- -
1h -10min2019-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"
按照获取 OAuth 2.0 访问令牌中的说明,将 $ACCESS_TOKEN 设置为您的 OAuth 2.0 访问令牌。如需了解此示例中使用的 curl 选项,请参阅 使用 curl。
此 API 支持以下可选查询参数:
| 名称 | 说明 | 默认 |
|---|---|---|
from
|
应提取提醒的时间间隔的开始时间。默认值为当前时间减去一小时。如需了解如何设置此参数,请参阅上面的说明。 | -1h |
to
|
应提取提醒的时间间隔的结束时间。默认值为当前时间。如需了解如何设置此参数,请参阅上面的说明。 | now |
alertId
|
按指定的提醒定义 ID 过滤提醒历史记录结果。 | 所有提醒 ID |
env
|
按指定环境过滤事件。 | 所有环境 |
name
|
按指定的提醒名称过滤事件。 | 所有提醒名称 |
region
|
按指定地区过滤事件。 | 所有地区 |
type
|
按指定类型过滤事件:alert。
|
所有类型 |