名前でデプロイされたサービスの種類の情報を取得する

  • [アーティクル]

Service Fabric クラスター内のノードにデプロイされたアプリケーションの指定されたサービスの種類に関する情報を取得します。

Service Fabric クラスター内のノードにデプロイされたアプリケーションから特定のサービスの種類に関する情報を含む一覧を取得します。 応答には、サービスの種類名、登録状態、それを登録したコード パッケージ、サービス パッケージのアクティブ化 ID が含まれています。 各エントリは、サービスの種類の 1 回のアクティブ化を表し、アクティブ化 ID で区別されます。

Request

Method 要求 URI
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}?api-version=6.0&ServiceManifestName={ServiceManifestName}&timeout={timeout}

パラメーター

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

nodeName

型: string
必須: はい

ノード名。

applicationId

型: string
必須: はい

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

serviceTypeName

型: string
必須: はい

Service Fabric サービスの種類の名前を指定します。

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

ServiceManifestName

型: string
必須: いいえ

デプロイされたサービスの種類の情報の一覧をフィルター処理するためのサービス マニフェストの名前。 指定した場合、応答には、このサービス マニフェストで定義されているサービスの種類に関する情報のみが含まれます。

timeout

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

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

応答

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