Alnév információs listájának lekérése v82

Az összes Service Fabric-név számbavétele egy adott név alatt.

Az összes Service Fabric-név számbavétele egy adott név alatt. Ha az alnevek nem férnek el egy lapon, a rendszer egy eredményoldalt ad vissza, valamint egy folytatási jogkivonatot, amely a következő oldal lekéréséhez használható. A nem létező név lekérdezése sikertelen lesz.

Kérés

Metódus	Kérés URI-ja
GET	/Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout}

Paraméterek

Név	Típus	Kötelező	Hely
nameId	sztring	Igen	Elérési út
api-version	sztring	Igen	Lekérdezés
Recursive	boolean	No	Lekérdezés
ContinuationToken	sztring	No	Lekérdezés
timeout	egész szám (int64)	No	Lekérdezés

---

nameId

Típus: sztring
Kötelező: Igen

A Service Fabric neve a "háló:" URI-séma nélkül.

---

api-version

Típus: sztring
Kötelező: Igen
Alapértelmezett: 6.0

Az API verziója. Ez a paraméter kötelező, értéke pedig "6.0".

A Service Fabric REST API-verziója azon a futtatókörnyezeti verzión alapul, amelyben az API-t bevezették vagy módosították. A Service Fabric-futtatókörnyezet az API több verzióját is támogatja. Ez az API legújabb támogatott verziója. Ha egy alacsonyabb API-verziót ad át, a visszaadott válasz eltérhet az ebben a specifikációban dokumentálttól.

Emellett a futtatókörnyezet elfogad minden olyan verziót, amely magasabb, mint a legújabb támogatott verzió, egészen a futtatókörnyezet aktuális verziójáig. Ha tehát a legújabb API-verzió a 6.0, de a futtatókörnyezet 6.1, az ügyfelek írásának megkönnyítése érdekében a futtatókörnyezet elfogadja az API 6.1-es verzióját. Az API viselkedése azonban a dokumentált 6.0-s verziónak megfelelően fog változni.

---

Recursive

Típus: logikai
Kötelező: Nem
Alapértelmezett: false

Lehetővé teszi annak megadását, hogy a végrehajtott keresésnek rekurzívnak kell lennie.

---

ContinuationToken

Típus: sztring
Kötelező: Nem

A folytatási jogkivonat paramétere a következő eredmények lekérésére szolgál. Az API válaszában szerepel egy nem üres értékkel rendelkező folytatási jogkivonat, ha a rendszer eredményei nem férnek el egyetlen válaszban. Amikor ezt az értéket átadja a következő API-hívásnak, az API a következő eredményhalmazt adja vissza. Ha nincs további eredmény, akkor a folytatási jogkivonat nem tartalmaz értéket. Ennek a paraméternek az értéke nem lehet URL-kódolású.

---

timeout

Típus: egész szám (int64)
Kötelező: Nem
Alapértelmezett: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

A kiszolgáló időtúllépése a művelet másodpercben történő végrehajtásához. Ez az időtúllépés azt az időtartamot adja meg, amelyet az ügyfél hajlandó megvárni a kért művelet befejezéséig. A paraméter alapértelmezett értéke 60 másodperc.

Válaszok

HTTP-állapotkód	Description	Válaszséma
200 (OK)	A Service Fabric-nevek lapozott listája.	PagedSubNameInfoList
Minden más állapotkód	A részletes hibaválasz.	FabricError

Példák

Alnevek lekérése

Ez a példa bemutatja, hogyan kérhet le információkat egy adott Service Fabric-név összes alnevéről.

Kérés

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

200 Válasz

Törzs

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

Rekurzív keresés alnevekben

Ez a példa bemutatja, hogyan kérhet le rekurzív módon információkat egy adott Service Fabric-név összes gyermek alnevéről.

Kérés

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

200 Válasz

Törzs

{
  "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"
  ]
}

Oldal folytatási jogkivonattal

Ez a példa bemutatja, hogyan lehet egy adott Service Fabric-név alneveinek adatait átlaposíteni a ContinuationToken paraméterrel. Ennek a paraméternek az értékét az előző lekérdezés adja meg, ebben az esetben a fenti példában. A válasz a fennmaradó két eredményt és egy üres ContinuationToken értéket tartalmazza. Az üres ContinuationToken azt jelzi, hogy további eredmények nem érhetők el.

Kérés

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

200 Válasz

Törzs

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