配置されていないレプリカ情報を取得する

  • [アーティクル]

サービスの配置されていないレプリカに関する情報を取得します。

サービスの配置されていないレプリカに関する情報を返します。 PartitionId が指定されている場合、result には、そのパーティションの未配置のレプリカに関する情報のみが含まれます。 PartitionId が指定されていない場合、結果には、そのサービスのすべてのパーティションの未配置レプリカに関する情報が含まれます。 OnlyQueryPrimaries が true に設定されている場合、result にはプライマリ レプリカに関する情報のみが含まれるので、配置されていないセカンダリ レプリカは無視されます。

Request

Method 要求 URI
GET /Services/{serviceId}/$/GetUnplacedReplicaInformation?api-version=6.4&PartitionId={PartitionId}&OnlyQueryPrimaries={OnlyQueryPrimaries}&timeout={timeout}

パラメーター

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

serviceId

型: string
必須: はい

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

api-version

型: string
必須: はい
既定値:

API のバージョン。 このパラメーターは必須であり、その値は '6.4' である必要があります。

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。

OnlyQueryPrimaries

型: ブール値
必須: いいえ
既定値:

配置されていないレプリカ情報がプライマリ レプリカに対してのみクエリされることを示します。

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) 指定されたサービスに関する情報。
 UnplacedReplicaInformation
その他すべての状態コード 詳細なエラー応答。
 FabricError