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 時間です。このパラメータの設定については、前述の説明をご覧ください。 | -1h |
to
|
アラートを取得する時間間隔の終わり。デフォルト値は現在の時刻です。このパラメータの設定については、前述の説明をご覧ください。 | now |
alertId
|
アラート履歴の結果を指定したアラート定義 ID でフィルタします。 | すべてのアラート ID |
env
|
イベントを指定した環境でフィルタします。 | すべての環境 |
name
|
イベントを指定したアラート名でフィルタします。 | すべてのアラート名 |
region
|
イベントを指定したリージョンでフィルタします。 | すべてのリージョン |
type
|
イベントを指定したタイプ（alert）でフィルタします。 |
すべての種類 |