[インフラストラクチャの呼び出し] コマンド

  • [アーティクル]

特定の Infrastructure Service インスタンスで管理コマンドを呼び出します。

構成済みの Infrastructure Service のインスタンスが 1 つ以上あるクラスターの場合、この API を使用して、Infrastructure Service の特定のインスタンスにインフラストラクチャ固有のコマンドを送信することができます。

使用可能なコマンドと、対応する応答の形式は、クラスターが実行されているインフラストラクチャによって異なります。

この API は、Service Fabric プラットフォームをサポートしています。コードから直接使用するものではありません。

Request

Method 要求 URI
POST /$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout}

パラメーター

名前 Type 必須 場所
api-version string はい クエリ
Command string はい クエリ
ServiceId string いいえ クエリ
timeout integer (int64) いいえ クエリ

api-version

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

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

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

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

Command

型: string
必須: はい

呼び出されるコマンドのテキスト。 コマンドの内容は、インフラストラクチャに固有です。

ServiceId

型: string
必須: いいえ

Infrastructure Service の ID。 これは "fabric:" URI スキームのない Infrastructure Service の完全な名前です。 このパラメーターは、実行している Infrastructure Service のインスタンスを複数持つクラスターにのみ必要です。

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) インフラストラクチャ サービスからの応答。 応答形式は JSON ストリームです。
応答の内容は、発行されたコマンドによって異なります。
 string
その他のすべての状態コード 詳細なエラー応答。
 FabricError