アプリケーション情報リストを取得する

  • [アーティクル]

Service Fabric クラスター内に作成されているアプリケーションのうち、指定したフィルターに一致するものの一覧を取得します。

Service Fabric クラスターで作成済みまたは作成中のアプリケーションのうち、指定したフィルターと一致するものに関する情報を取得します。 応答には、名前、種類、状態、パラメーター、およびアプリケーションに関するその他の詳細が含まれています。 アプリケーションが 1 ページに収まらない場合、1 ページの結果と継続トークンが返されます。これは次のページを取得するために使用できます。 フィルター ApplicationTypeName と ApplicationDefinitionKindFilter を同時に指定することはできません。

Request

Method 要求 URI
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

パラメーター

名前 Type 必須 場所
api-version string はい クエリ
ApplicationDefinitionKindFilter 整数 (integer) いいえ クエリ
ApplicationTypeName string いいえ クエリ
ExcludeApplicationParameters boolean いいえ クエリ
ContinuationToken string いいえ クエリ
MaxResults integer (int64) いいえ クエリ
timeout integer (int64) いいえ クエリ

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 バージョンに従います。

ApplicationDefinitionKindFilter

型: 整数
必須: いいえ
既定値:

Service Fabric アプリケーションを定義するためのメカニズムである ApplicationDefinitionKind でのフィルターに使われます。

  • 既定値 - 既定値。"すべて" を選択した場合と同じ関数を実行します。 値は 0 です。
  • [すべて] - 任意の ApplicationDefinitionKind 値を持つ入力と一致するフィルター。 値は 65535 です。
  • ServiceFabricApplicationDescription - ApplicationDefinitionKind 値 ServiceFabricApplicationDescription との入力と一致するフィルター。 値は 1 です。
  • Compose - ApplicationDefinitionKind 値 Compose を使用して入力と一致するフィルター。 値は 2 です。

ApplicationTypeName

型: string
必須: いいえ

クエリを実行するアプリケーションをフィルター処理するために使用されるアプリケーションの種類名。 この値にアプリケーションの種類のバージョンを含めることはできません。

ExcludeApplicationParameters

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

アプリケーションのパラメーターを結果から除外するかどうかを指定するフラグ。

ContinuationToken

型: string
必須: いいえ

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

MaxResults

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

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

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) クラスターで作成されたアプリケーションの一覧。
 PagedApplicationInfoList
その他のすべての状態コード 詳細なエラー応答。
 FabricError

使用例

最大結果を制限する

この例では、クラスター上のアプリケーションに関する情報を取得する方法を示します。 ページ内の結果の数は、MaxResult パラメーターを使用して最大 2 つに制限されます。

要求

GET http://localhost:19080/Applications?api-version=6.1&MaxResults=2

200 応答

本文
{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}

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

この例では、ContinuationToken パラメーターを使用して、クラスター上のアプリケーションに関する情報をページングする方法を示します。 このパラメーターの値は、前のクエリ (この場合は上記の例) から提供されます。 応答には、残りの 1 つの結果と空の ContinuationToken が含まれます。 空の ContinuationToken は、追加の結果が使用できないことを示します。

要求

GET http://localhost:19080/Applications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1&MaxResults=2

200 応答

本文
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}