デプロイされたサービス レプリカ情報の一覧を取得する

  • [アーティクル]

Service Fabric ノードにデプロイされているレプリカの一覧を取得します。

Service Fabric ノードにデプロイされたレプリカに関する情報を含むリストを取得します。 情報には、パーティション ID、レプリカ ID、レプリカの状態、サービスの名前、サービスの種類の名前、その他の情報が含まれます。 これらのパラメーターの指定した値と一致するデプロイ済みレプリカに関する情報を取得するには、PartitionId または ServiceManifestName クエリ パラメーターを使用します。

Request

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

パラメーター

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

nodeName

型: string
必須: はい

ノード名。

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

PartitionId

型: string (uuid)
必須: いいえ

パーティションの ID。

ServiceManifestName

型: string
必須: いいえ

Service Fabric クラスターでアプリケーションの種類の一部として登録されているサービス マニフェストの名前。

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) 操作が成功すると、200 の状態コードと、デプロイされたサービス レプリカ情報の一覧が返されます。
 DeployedServiceReplicaInfo の配列
204 (NoContent) 指定した applicationId が指定されたノードで見つからない場合は、空の応答が返されます。 PartitionId または ServiceManifestName クエリ パラメーターに指定されたフィルター値と一致するレプリカがない場合も、空の応答が返されます。
その他すべての状態コード 詳細なエラー応答。
 FabricError