Obtenir la liste d’informations sur le réplica de service déployé

Article
08/05/2023

Permet d’obtenir la liste des réplicas déployés sur un nœud Service Fabric.

Permet d’obtenir la liste contenant les informations sur les réplicas déployés sur un nœud Service Fabric. Les informations comprennent l’ID de partition, l’ID de réplica, l’état du réplica, le nom du service, le nom du type de service et autres. Utilisez les paramètres de requête PartitionId ou ServiceManifestName pour retourner des informations sur les réplicas déployés qui correspondent aux valeurs spécifiées de ces paramètres.

Requête

Méthode	URI de demande
GET	`/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas?api-version=6.0&PartitionId={PartitionId}&ServiceManifestName={ServiceManifestName}&timeout={timeout}`

Paramètres

Nom	Type	Obligatoire	Emplacement
`nodeName`	string	Oui	Chemin d’accès
`applicationId`	string	Oui	Chemin d’accès
`api-version`	string	Oui	Requête
`PartitionId`	string (uuid)	Non	Requête
`ServiceManifestName`	string	Non	Requête
`timeout`	integer (int64)	Non	Requête

`nodeName`

Type : chaîne
Obligatoire : Oui

Nom du nœud.

`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.

`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 inférieure de l’API est passée, 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 que 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 conformément à la version 6.0 documentée.

`PartitionId`

Type : chaîne (uuid)
Obligatoire : Non

Identité de la partition.

`ServiceManifestName`

Type : chaîne
Obligatoire : Non

Nom d’un manifeste de service inscrit dans le cadre d’un type d’application dans un cluster Service Fabric.

`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)	Une opération réussie retourne 200 status code et la liste des informations de réplica de service déployées.	tableau de DeployedServiceReplicaInfo
204 (NoContent)	Une réponse vide est retournée si l’id d’application spécifié est introuvable sur le nœud spécifié. Une réponse vide est également retournée s’il n’existe aucun réplica correspondant aux valeurs de filtre spécifiées pour les paramètres de requête PartitionId ou ServiceManifestName.
Tous les autres codes status	Réponse d’erreur détaillée.	FabricError

Partager via