Chaos イベントを取得する

  • [アーティクル]

継続トークンまたは時間範囲に基づいて Chaos イベントの次のセグメントを取得します。

Chaos イベントの次のセグメントを取得するには、ContinuationToken を指定できます。 Chaos イベントの新しいセグメントの開始を取得するには、StartTimeUtc と EndTimeUtc を使って時間範囲を指定できます。 ContinuationToken と時間範囲の両方を同じ呼び出しで指定することはできません。 Chaos イベントの数が 100 を超える場合、Chaos イベントは複数のセグメントで返されます。各セグメントに含まれる Chaos イベントの数は 100 個以下で、次のセグメントを取得するには継続トークンを指定してこの API を呼び出します。

Request

Method 要求 URI
GET /Tools/Chaos/Events?api-version=6.2&ContinuationToken={ContinuationToken}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&MaxResults={MaxResults}&timeout={timeout}

パラメーター

名前 Type 必須 場所
api-version string はい クエリ
ContinuationToken string いいえ クエリ
StartTimeUtc string いいえ クエリ
EndTimeUtc string いいえ クエリ
MaxResults integer (int64) いいえ クエリ
timeout integer (int64) いいえ クエリ

api-version

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

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

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

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

ContinuationToken

型: string
必須: いいえ

継続トークンのパラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合は、空以外の値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API が次の結果セットを返します。 それ以上の結果がない場合は、継続トークンに値が含まれません。 このパラメーターの値を URL にエンコードすることはできません。

StartTimeUtc

型: string
必須: いいえ

Chaos レポートが生成される時間範囲の開始時刻を表す Windows ファイル時間。 詳しくは、「DateTime.ToFileTimeUtc Method」(DateTime.ToFileTimeUtc メソッド) をご覧ください。

EndTimeUtc

型: string
必須: いいえ

Chaos レポートが生成される時間範囲の終了時刻を表す Windows ファイル時間。 詳しくは、「DateTime.ToFileTimeUtc Method」(DateTime.ToFileTimeUtc メソッド) をご覧ください。

MaxResults

型: integer (int64)
必須: いいえ
既定値:
InclusiveMinimum: 0

ページング クエリの一部として返される結果の最大数。 このパラメーターは、返される結果の数に上限を定義します。 返された結果が、構成で定義したメッセージの最大サイズの制限に収まらない場合は、指定した最大結果数よりも少なくなる場合があります。 このパラメーターがゼロまたは指定されていない場合、ページング クエリには、応答メッセージに収まるできるだけ多くの結果が含まれます。

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) Chaos イベントの次のセグメント。
 ChaosEventsSegment
その他すべての状態コード 詳細なエラー応答。
 FabricError

使用例

時間範囲を指定して Chaos イベントを取得する

この例では、ContinuationToken パラメーターをページングすることなく、単一の応答メッセージで Chaos イベントを取得する方法を示します。

要求

GET http://localhost:19080/Tools/Chaos/Events?api-version=6.2&StartTimeUtc=0&EndTimeUtc=3155378975999999999

200 応答

本文
{
  "ContinuationToken": "",
  "History": [
    {
      "ChaosEvent": {
        "Kind": "Started",
        "TimeStampUtc": "2017-04-14T04:27:19.049Z",
        "ChaosParameters": {
          "MaxClusterStabilizationTimeoutInSeconds": "30",
          "MaxConcurrentFaults": "3",
          "WaitTimeBetweenIterationsInSeconds": "10",
          "WaitTimeBetweenFaultsInSeconds": "1",
          "TimeToRunInSeconds": "3600",
          "EnableMoveReplicaFaults": true,
          "ClusterHealthPolicy": {
            "ConsiderWarningAsError": true,
            "MaxPercentUnhealthyNodes": "0",
            "MaxPercentUnhealthyApplications": "10",
            "ApplicationTypeHealthPolicyMap": [
              {
                "Key": "myapp",
                "Value": "3"
              }
            ]
          },
          "Context": {
            "Map": {
              "k1": "v1",
              "k2": "v2",
              "k3": "v5"
            }
          }
        }
      }
    },
    {
      "ChaosEvent": {
        "Kind": "ExecutingFaults",
        "TimeStampUtc": "2017-04-14T04:27:20.667Z",
        "Faults": [
          "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_1, PartitionId: 6a91b09a-bd76-45da-afaa-ed0fd9bfe7d2, ReplicaId: 131366172775684622",
          "ActionType: CodePackageRestart, NodeName: N0050, ApplicationName: fabric:/TestApp1, ServiceManifestName: SP1, ServiceManifestName: , CodePackageName: CP1.",
          "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_3, PartitionId: baa3a51e-5c42-435e-89d3-6e97b2164661, ReplicaId: 131366172988968762"
        ]
      }
    }
  ]
}