デプロイされたアプリケーション情報を取得する

  • [アーティクル]

Service Fabric ノードにデプロイされたアプリケーションに関する情報を取得します。

指定されたアプリケーション ID がシステム アプリケーションのものである場合、このクエリはシステム アプリケーションの情報を返します。 結果には、アクティブ、アクティブ化中、およびダウンロード中の状態の展開済みアプリケーションが含まれます。 このクエリでは、ノード名がクラスター上のノードに対応している必要があります。 指定されたノード名がクラスター上のアクティブな Service Fabric ノードを示していない場合、クエリは失敗します。

Request

Method 要求 URI
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}

パラメーター

名前 Type 必須 場所
nodeName string はい パス
applicationId string はい パス
api-version string はい クエリ
timeout integer (int64) いいえ クエリ
IncludeHealthState boolean いいえ クエリ

nodeName

型: string
必須: はい

ノード名。

applicationId

型: string
必須: はい

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

api-version

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

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

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 秒です。

IncludeHealthState

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

エンティティの正常性の状態を含めます。 このパラメーターが false の場合、または指定されていない場合は、返される正常性状態は "Unknown" です。 true に設定すると、結果がマージされる前に、クエリはノードと正常性システム サービスに並列で渡されます。 その結果、クエリはコストが高くなり、長い時間がかかる場合があります。

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) 操作が成功すると、200 の状態コードと、デプロイされたアプリケーションに関する情報が返されます。
 DeployedApplicationInfo
204 (NoContent) 指定したアプリケーションがノードにデプロイされていない場合は、空の応答が返されます。
その他すべての状態コード 詳細なエラー応答。
 FabricError

使用例

アプリケーション ID でデプロイされた特定のアプリケーションを取得し、結果に正常性状態を含める

この例では、アプリケーション識別子を使用して、指定したノードにデプロイされたアプリケーションに関する情報を取得する方法を示します。 アプリケーションが見つかった場合は、200 の状態コードで情報が返されます。 指定したアプリケーションがノードにデプロイされていない場合は、状態コード 204 の空の応答が返されます。

要求

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True

200 応答

本文
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0.0",
  "Status": "Active",
  "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
  "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
  "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
  "HealthState": "Ok"
}

204 応答

本文

応答本文は空です。