サブ名情報リストを取得する

  • [アーティクル]

指定した名前のすべての Service Fabric 名を列挙します。

指定した名前のすべての Service Fabric 名を列挙します。 サブ名がページに収まらない場合は、結果の 1 ページと継続トークンが返されます。これは、次のページを取得するために使用できます。 存在しない名前のクエリは失敗します。

Request

Method 要求 URI
GET /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout}

パラメーター

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

nameId

型: string
必須: はい

"fabric:" URI スキームを除いた 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 バージョンに従います。

Recursive

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

実行する検索を再帰的にする必要があることを指定できます。

ContinuationToken

型: string
必須: いいえ

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

timeout

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

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

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) Service Fabric 名のページ一覧。
 PagedSubNameInfoList
その他のすべての状態コード 詳細なエラー応答。
 FabricError

使用例

サブ名を取得する

この例では、指定された Service Fabric 名のすべてのサブ名に関する情報を取得する方法を示します。

要求

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0

200 応答

本文
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/mynames"
  ]
}

サブ名を再帰的に検索する

この例では、特定の Service Fabric 名のすべての子サブ名に関する情報を再帰的に取得する方法を示します。

要求

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True

200 応答

本文
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps",
    "fabric:/samples/data",
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/CalculatorApp/CalculatorService",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-1",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-2",
    "fabric:/samples/mynames/name-1"
  ]
}

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

この例では、ContinuationToken パラメーターを使用して、指定された Service Fabric 名の下のサブ名に関する情報をページングする方法を示します。 このパラメーターの値は、前のクエリ (この場合は上記の例) から提供されます。 応答には、残りの 2 つの結果と空の ContinuationToken が含まれています。 空の ContinuationToken は、追加の結果が使用できないことを示します。

要求

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True&ContinuationToken=fabric:/samples/apps/PersistentQueueApp$131439231986491349

200 応答

本文
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps/VolatileQueueApp",
    "fabric:/samples/apps/NotepadApp"
  ]
}