Alkalmazástípus-információs lista lekérése név szerint v82

Lekéri a Service Fabric-fürt azon alkalmazástípusainak listáját, amelyek pontosan megfelelnek a megadott névnek.

A kiépített vagy a Service Fabric-fürtben üzembe helyezés alatt álló alkalmazástípusokra vonatkozó információkat adja vissza. Ezek az eredmények olyan alkalmazástípusok, amelyek neve pontosan megegyezik a paraméterként megadott névvel, és amelyek megfelelnek a megadott lekérdezési paramétereknek. A rendszer az alkalmazástípus nevének megfelelő összes verziót visszaadja, és minden verziót egyetlen alkalmazástípusként ad vissza. A válasz tartalmazza az alkalmazás típusának nevét, verzióját, állapotát és egyéb adatait. Ez egy lapozott lekérdezés, ami azt jelenti, hogy ha nem minden alkalmazástípus fér el egy lapon, a rendszer egy oldalnyi eredményt ad vissza, valamint egy folytatási jogkivonatot, amely a következő oldal lekéréséhez használható. Ha például 10 alkalmazástípus van, de egy oldal csak az első három alkalmazástípusnak felel meg, vagy ha a maximális eredmény 3-ra van állítva, akkor a rendszer három értéket ad vissza. A többi eredmény eléréséhez kérje le a következő oldalakat a következő lekérdezés visszaadott folytatási jogkivonatával. Ha nincsenek további lapok, a rendszer üres folytatási jogkivonatot ad vissza.

Kérés

Metódus	Kérés URI-ja
GET	/ApplicationTypes/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Paraméterek

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

---

applicationTypeName

Típus: sztring
Kötelező: Igen

Az alkalmazástípus neve.

---

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 minden olyan verziót elfogad, amely magasabb, mint a legújabb támogatott verzió, egészen a futtatókörnyezet aktuális verziójáig. Tehát ha a legújabb API-verzió a 6.0, de ha 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.

---

ApplicationTypeVersion

Típus: sztring
Kötelező: Nem

Az alkalmazástípus verziója.

---

ExcludeApplicationParameters

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

A jelző, amely meghatározza, hogy az alkalmazásparaméterek ki lesznek-e zárva az eredményből.

---

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 nincsenek további eredmények, akkor a folytatási jogkivonat nem tartalmaz értéket. Ennek a paraméternek az értéke nem lehet URL-kódolású.

---

MaxResults

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

A lapozott lekérdezések részeként visszaadandó eredmények maximális száma. Ez a paraméter határozza meg a visszaadott eredmények számának felső határát. A visszaadott eredmények kisebbek lehetnek a megadott maximális eredménynél, ha nem férnek el az üzenetben a konfigurációban meghatározott maximális üzenetméret-korlátozásoknak megfelelően. Ha ez a paraméter nulla vagy nincs megadva, a lapozott lekérdezés a lehető legtöbb eredményt tartalmazza, amely illeszkedik a visszatérési üzenetbe.

---

timeout

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

A művelet végrehajtásának kiszolgálói időtúllépése másodpercben. 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 fürtben található alkalmazástípusok listája.	PagedApplicationTypeInfoList
Minden más állapotkód	A részletes hibaválasz.	Hálóerror