アプリケーション イベント リストの取得

  • [アーティクル]

1 つのアプリケーション関連のイベントを取得します。

応答は ApplicationEvent オブジェクトの一覧です。

Request

Method 要求 URI
GET /EventsStore/Applications/{applicationId}/$/Events?api-version=6.4&timeout={timeout}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&EventsTypesFilter={EventsTypesFilter}&ExcludeAnalysisEvents={ExcludeAnalysisEvents}&SkipCorrelationLookup={SkipCorrelationLookup}

パラメーター

名前 Type 必須 場所
applicationId string はい パス
api-version string はい クエリ
timeout integer (int64) いいえ クエリ
StartTimeUtc string はい クエリ
EndTimeUtc string はい クエリ
EventsTypesFilter string いいえ クエリ
ExcludeAnalysisEvents boolean いいえ クエリ
SkipCorrelationLookup boolean いいえ クエリ

applicationId

型: string
必須: はい

アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。

api-version

型: string
必須: はい
既定値:

API のバージョン。 このパラメーターは必須であり、その値は '6.4' である必要があります。

Service Fabric REST API のバージョンは、API が導入または変更されたランタイム バージョンに基づいています。 Service Fabric ランタイムでは、複数のバージョンの API がサポートされています。 このバージョンは、サポートされている API の最新バージョンです。 より低い API バージョンが渡された場合、返される応答は、この仕様に記載されている応答とは異なる場合があります。

さらに、ランタイムは、現在のバージョンのランタイムまで、サポートされている最新バージョンより高いバージョンを受け入れます。 そのため、最新の API バージョンが 6.0 で、ランタイムが 6.1 の場合、ランタイムはその API のバージョン 6.1 を受け入れます。 ただし、API の動作は、文書化されている 6.0 バージョンに従います。

timeout

型: integer (int64)
必須: いいえ
既定値:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。

StartTimeUtc

型: string
必須: はい

参照クエリの開始時刻 (ISO UTC yyyy-MM-ddTHH:mm:ssZ 形式)。

EndTimeUtc

型: string
必須: はい

参照クエリの終了時刻 (ISO UTC yyyy-MM-ddTHH:mm:ssZ 形式)。

EventsTypesFilter

型: string
必須: いいえ

これは、応答にのみ含める FabricEvents の種類を指定するコンマ区切りの文字列です。

ExcludeAnalysisEvents

型: ブール値
必須: いいえ

このパラメーターを指定すると、true が渡された場合に AnalysisEvents の取得が無効になります。

SkipCorrelationLookup

型: ブール値
必須: いいえ

このパラメーターを指定すると、true が渡された場合に CorrelatedEvents 情報の検索が無効になります。 それ以外の場合、CorrelationEvents が処理され、すべての FabricEvent の HasCorrelatedEvents フィールドに値が設定されます。

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) 基本型 ApplicationEvent を持つイベント オブジェクトの一覧。
 ApplicationEvent の配列
その他すべての状態コード 詳細なエラー応答。
 FabricError

使用例

この例では、特定の時間枠内のすべてのアプリケーション関連イベントを取得する方法を示します。

要求

GET http://localhost:19080/EventsStore/Applications/app1/$/Events?api-version=6.4&StartTimeUtc=2018-04-03T18:00:00Z&EndTimeUtc=2018-04-04T18:00:00Z

200 応答

本文
[
  {
    "Kind": "ApplicationCreated",
    "ApplicationTypeName": "App1Type",
    "ApplicationTypeVersion": "1.0.1",
    "ApplicationDefinitionKind": "ServiceFabricApplicationDescription",
    "ApplicationId": "app1",
    "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10",
    "TimeStamp": "2018-04-03T20:21:23.5774199Z",
    "HasCorrelatedEvents": false
  }
]