Obtenir la liste d’informations de service

Article
07/19/2023

Permet d’obtenir les informations sur tous les services faisant partie de l’application spécifiée par l’ID d’application.

Retourne les informations sur tous les services faisant partie de l’application spécifiée par l’ID d’application.

Requête

Méthode	URI de demande
GET	`/Applications/{applicationId}/$/GetServices?ServiceTypeName={ServiceTypeName}&api-version=6.0&ContinuationToken={ContinuationToken}&timeout={timeout}`

Paramètres

Nom	Type	Obligatoire	Emplacement
`applicationId`	string	Oui	Chemin d’accès
`ServiceTypeName`	string	Non	Requête
`api-version`	string	Oui	Requête
`ContinuationToken`	string	Non	Requête
`timeout`	entier (int64)	Non	Requête

`applicationId`

Type : chaîne
Obligatoire : Oui

Identité de l’application. Il s’agit généralement du nom complet de l’application, sans « fabric ». Schéma d’URI. Depuis la version 6.0, les noms hiérarchiques sont séparés par le caractère « ~ ». Par exemple, si une application est nommée « fabric://mon_app/app1 », son identité est « mon_app~app1 » dans les versions 6.0 et supérieures, et « mon_app/app1 » dans les versions précédentes.

`ServiceTypeName`

Type : chaîne
Obligatoire : Non

Nom du type de service utilisé pour filtrer les services correspondant à la requête.

`api-version`

Type : chaîne
Obligatoire : Oui
Par défaut : 6.0

Version de l’API. Ce paramètre est obligatoire et sa valeur doit être « 6.0 ».

La version de l’API REST Service Fabric est basée sur la version du runtime dans laquelle l’API a été introduite ou a été modifiée. Le runtime Service Fabric prend en charge plusieurs versions de l’API. Il s’agit de la dernière version prise en charge de l’API. Si une version d’API inférieure est transmise, la réponse retournée peut être différente de celle documentée dans cette spécification.

En outre, le runtime accepte toute version supérieure à la dernière version prise en charge jusqu’à la version actuelle du runtime. Par conséquent, si la dernière version de l’API est 6.0, mais si le runtime est 6.1, afin de faciliter l’écriture des clients, le runtime accepte la version 6.1 pour cette API. Toutefois, le comportement de l’API sera en fonction de la version 6.0 documentée.

`ContinuationToken`

Type : chaîne
Obligatoire : Non

Le paramètre de jeton de liaison permet d’obtenir le jeu de résultats suivant. Un jeton de liaison avec une valeur non vide est inclus dans la réponse de l’API quand les résultats du système ne tiennent pas dans une seule réponse. Lorsque cette valeur est transmise à l’appel d’API suivant, l’API retourne le jeu de résultats suivant. S’il n’existe pas de résultats supplémentaires, le jeton de liaison ne contient pas de valeur. La valeur de ce paramètre ne doit pas être codée URL.

`timeout`

Type : integer (int64)
Obligatoire : Non
Par défaut : 60
InclusiveMaximum : 4294967295
InclusiveMinimum : 1

Délai d’attente du serveur pour l’exécution de l’opération en secondes. Il spécifie la durée pendant laquelle le client attend la fin de l’opération demandée. La valeur par défaut de ce paramètre est de 60 secondes.

Réponses

Code d’état HTTP	Description	Schéma de réponse
200 (OK)	Liste des services dans le cluster pour l’application spécifiée.	PagedServiceInfoList
Tous les autres codes status	Réponse d’erreur détaillée.	FabricError

Partager via