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

  • [アーティクル]

Service Fabric アプリケーションの情報を取得します。

Service Fabric クラスターで作成された、または作成中の、パラメーターとして指定されているものと同じ名前のアプリケーションの情報を返します。 応答には、名前、種類、状態、パラメーター、およびアプリケーションに関するその他の詳細が含まれています。

Request

Method 要求 URI
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

パラメーター

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

applicationId

型: string
必須: はい

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

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

ExcludeApplicationParameters

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

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

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) アプリケーションに関する情報。
 ApplicationInfo
204 (NoContent) 指定した applicationId がクラスターで見つからない場合は、空の応答が返されます。
その他のすべての状態コード 詳細なエラー応答。
 FabricError

使用例

アプリケーション ID で特定のアプリケーションを取得する

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

要求

GET http://localhost:19080/Applications/samples~CalculatorApp?api-version=6.0

200 応答

本文
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0",
  "Status": "Ready",
  "Parameters": [
    {
      "Key": "CalculatorAppParameter1",
      "Value": "314"
    },
    {
      "Key": "CalculatorAppParameter2",
      "Value": "271"
    }
  ],
  "HealthState": "Ok",
  "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
}

204 応答

本文

応答本文は空です。