Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報
/metrics/events API を使用して、指定した時間間隔で組織内のすべてのイベントを取得します。イベントのリストには、Edge によって検出されたすべてのアラートが含まれます。
デフォルトでは、API は過去 1 時間のすべてのイベントを返します。別の期間を指定するには、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
|
アラートを取得する期間の開始日時。デフォルト値は、現在の時刻から 1 時間を差し引いたものです。このパラメータの設定については、上記の説明をご覧ください。 | -1 時間 |
to
|
アラートをフェッチする期間の終了。デフォルト値は現在時刻です。このパラメータの設定については、上記の説明をご覧ください。 | たった今 |
alertId
|
アラート履歴の結果を、指定したアラート定義 ID でフィルタします。 | すべてのアラート ID |
env
|
指定した環境でイベントをフィルタします。 | すべての環境 |
name
|
指定したアラート名でイベントをフィルタします。 | すべてのアラート名 |
region
|
指定したリージョンでイベントをフィルタします。 | すべてのリージョン |
type
|
指定されたタイプ alert でイベントをフィルタします。 |
すべての種類 |