Alkalmazás típusú adatok listájának beolvasása név alapjánGet Application Type Info List By Name

Beolvassa a Service Fabric-fürtben található, pontosan a megadott névvel egyező típusú alkalmazások listáját.Gets the list of application types in the Service Fabric cluster matching exactly the specified name.

A kiépített vagy a Service Fabric fürtben kiépített alkalmazási típusok adatait adja vissza.Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Ezek az eredmények olyan típusú alkalmazások, amelyek neve pontosan egyezik a paraméterként megadott névvel, és amelyek megfelelnek a megadott lekérdezési paramétereknek.These results are of application types whose name match exactly the one specified as the parameter, and which comply with the given query parameters. Az alkalmazás típusának nevével egyező összes verziót adja vissza a rendszer, és mindegyik verzió egyetlen alkalmazás típusúként lett visszaadva.All versions of the application type matching the application type name are returned, with each version returned as one application type. A válasz tartalmazza az alkalmazás típusának nevét, verziószámát, állapotát és egyéb részleteit.The response includes the name, version, status, and other details about the application type. Ez egy lapozható lekérdezés, amely azt jelenti, hogy ha nem minden alkalmazás-típus fér el egy oldalon, a rendszer az eredmények egyik oldalát adja vissza, valamint egy folytatási tokent, amely a következő oldal beolvasására használható.This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Ha például 10 alkalmazás típusa van, de egy oldal csak az első három alkalmazás típushoz fér hozzá, vagy ha a max results értéke 3, akkor a rendszer három értéket ad vissza.For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. A többi eredmény eléréséhez a következő lekérdezésben a visszaadott folytatási token használatával kérje le a következő lapokat.To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. Üres folytatási tokent ad vissza, ha nincsenek további lapok.An empty continuation token is returned if there are no subsequent pages.

KérésRequest

MódszerMethod Kérés URI-jaRequest URI
GETGET /ApplicationTypes/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

ParaméterekParameters

Name (Név)Name TípusType KötelezőRequired HelyLocation
applicationTypeName sztringstring IgenYes ÚtvonalPath
api-version sztringstring IgenYes LekérdezésQuery
ApplicationTypeVersion sztringstring NemNo LekérdezésQuery
ExcludeApplicationParameters logikaiboolean NemNo LekérdezésQuery
ContinuationToken sztringstring NemNo LekérdezésQuery
MaxResults egész szám (Int64)integer (int64) NemNo LekérdezésQuery
timeout egész szám (Int64)integer (int64) NemNo LekérdezésQuery

applicationTypeName

Típus: karakterláncType: string
Kötelező: igenRequired: Yes

Az alkalmazás típusának neve.The name of the application type.


api-version

Típus: karakterláncType: string
Kötelező: igenRequired: Yes
Alapértelmezett:6.0Default: 6.0

Az API verziója.The version of the API. Ezt a paramétert kötelező megadni, és az értéke csak "6,0" lehet.This parameter is required and its value must be '6.0'.

A Service Fabric REST API verziója azon futtatókörnyezet-verzión alapul, amelyben az API-t bevezették vagy módosították.Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric futtatókörnyezet az API több verzióját is támogatja.Service Fabric runtime supports more than one version of the API. Ez az API legújabb támogatott verziója.This is the latest supported version of the API. Ha a rendszer alacsonyabb API-verziót ad át, a visszaadott válasz különbözhet az ebben a specifikációban dokumentált értéktől.If a lower API version is passed, the returned response may be different from the one documented in this specification.

Emellett a futtatókörnyezet minden olyan verziót elfogad, amely a legújabb támogatott verziónál magasabb, mint a futtatókörnyezet aktuális verziója.Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. Tehát ha a legújabb API-verzió a 6,0-as, de ha a futtatókörnyezet 6,1, az ügyfelek írásához a futtatókörnyezet az adott API-hoz tartozó 6,1-as verziót fogja elfogadni.So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. Az API viselkedése azonban a dokumentált 6,0-es verziónak megfelelően fog történni.However the behavior of the API will be as per the documented 6.0 version.


ApplicationTypeVersion

Típus: karakterláncType: string
Kötelező: nemRequired: No

Az alkalmazás típusának verziója.The version of the application type.


ExcludeApplicationParameters

Típus: BooleanType: boolean
Kötelező: nemRequired: No
Alapértelmezett:falseDefault: false

A jelző, amely megadja, hogy az alkalmazás paramétereinek ki lesznek-e zárva az eredményből.The flag that specifies whether application parameters will be excluded from the result.


ContinuationToken

Típus: karakterláncType: string
Kötelező: nemRequired: No

A folytatási jogkivonat paraméter az eredmények következő készletének beszerzésére szolgál.The continuation token parameter is used to obtain next set of results. Egy nem üres értékkel rendelkező folytatási token szerepel az API válaszában, ha a rendszer eredményei nem illeszkednek egyetlen válaszhoz.A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. Ha ezt az értéket átadja a következő API-hívásnak, az API az eredmények következő készletét adja vissza.When this value is passed to the next API call, the API returns next set of results. Ha nincs további eredmény, akkor a folytatási jogkivonat nem tartalmaz értéket.If there are no further results, then the continuation token does not contain a value. A paraméter értéke nem lehet URL-kódolású.The value of this parameter should not be URL encoded.


MaxResults

Típus: egész szám (Int64)Type: integer (int64)
Kötelező: nemRequired: No
Alapértelmezett:0Default: 0
InclusiveMinimum:0InclusiveMinimum: 0

A lapozható lekérdezések részeként visszaadott eredmények maximális száma.The maximum number of results to be returned as part of the paged queries. Ez a paraméter a visszaadott eredmények számának felső határát határozza meg.This parameter defines the upper bound on the number of results returned. A visszaadott eredmények a megadott maximális eredményeknél kisebbek lehetnek, ha nem férnek hozzá az üzenethez, mint a konfigurációban definiált maximális üzenet méretére vonatkozó korlátozások.The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. Ha a paraméter értéke nulla vagy nincs megadva, a lapozható lekérdezés a visszaadott üzenetben szereplő lehető legtöbb eredményt tartalmazza.If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.


timeout

Típus: egész szám (Int64)Type: integer (int64)
Kötelező: nemRequired: No
Alapértelmezett:60Default: 60
InclusiveMaximum:4294967295InclusiveMaximum: 4294967295
InclusiveMinimum:1InclusiveMinimum: 1

A kiszolgáló időtúllépése másodpercben a művelet végrehajtására.The server timeout for performing the operation in seconds. Ez az időkorlát azt az időtartamot adja meg, ameddig az ügyfélnek várnia kell, amíg a kért művelet befejeződik.This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. A paraméter alapértelmezett értéke 60 másodperc.The default value for this parameter is 60 seconds.

VálaszokResponses

HTTP-állapotkódHTTP Status Code LeírásDescription VálaszsémaResponse Schema
200 (OK)200 (OK) A fürtben található alkalmazás-típusok listája.List of application types in the cluster.
PagedApplicationTypeInfoListPagedApplicationTypeInfoList
Minden egyéb állapotkódAll other status codes A hiba részletes válasza.The detailed error response.
FabricErrorFabricError