展開されたアプリケーション情報の一覧を取得する

[アーティクル]
07/19/2023

Service Fabric ノードにデプロイされたアプリケーションの一覧を取得します。

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

Request

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

パラメーター

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

`nodeName`

型: string
必須: はい

ノード名。

`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`

型: boolean
必須: いいえ
既定値:

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

`ContinuationToken`

型: string
必須: いいえ

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

`MaxResults`

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

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

応答

HTTP 状態コード	説明	応答スキーマ
200 (OK)	操作が成功すると、200 の状態コードと、デプロイされたアプリケーション情報の一覧が返されます。	PagedDeployedApplicationInfoList
その他のすべての状態コード	詳細なエラー応答。	FabricError

使用例

最大結果を制限する

この例では、特定のノードにデプロイされたアプリケーションに関する情報を取得するときに、クエリによって返されるアプリケーションの数を指定する方法を示します。 MaxResult パラメーターを使用すると、ページ内の結果の数は最大 2 に制限されます。この例では正常性状態は要求されないため、返される正常性状態は [不明] になります。

要求

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&MaxResults=2

200 応答

本文

{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Unknown"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Unknown"
    }
  ]
}

継続トークンを使用するページ

この例では、特定のノードにデプロイされたアプリケーションに関する情報を取得するときに使用できるページング機能を示します。この例では、ContinuationToken パラメーターを使用します。このパラメーターの値は、前のクエリから提供されます。この場合は、上記の例を参照してください。応答には、残りの結果と空の ContinuationToken が含まれています。空の ContinuationToken は、追加の結果が使用できないことを示します。

要求

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1

200 応答

本文

{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Unknown"
    }
  ]
}

結果に正常性状態を含める

この例では、特定のノードにデプロイされたアプリケーションに関する情報を取得するときに、デプロイされた各アプリケーションの正常性状態を含める方法を示します。

要求

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

200 応答

本文

{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Ok"
    }
  ]
}

展開されたアプリケーション情報の一覧を取得する

Request

パラメーター

nodeName

api-version

timeout

IncludeHealthState

ContinuationToken

MaxResults

応答

使用例

最大結果を制限する

要求

200 応答

本文

継続トークンを使用するページ

要求

200 応答

本文

結果に正常性状態を含める

要求

200 応答

本文

その他のリソース

`nodeName`

`api-version`

`timeout`

`IncludeHealthState`

`ContinuationToken`

`MaxResults`