Partager via

Obtenir les informations sur l’application déployée

  • Article

Permet d’obtenir les informations relatives à une application déployée sur un nœud Service Fabric.

Cette requête renvoie des informations sur l’application système si l’ID d’application fourni est celui de l’application système. Les résultats incluent les applications déployées dont l’état est défini sur active, activating (activation) ou downloading (téléchargement). Pour cette requête, le nom de nœud doit obligatoirement correspondre à un nœud du cluster. Si le nom de nœud fourni ne pointe pas vers un nœud Service Fabric actif du cluster, la requête échoue.

Requête

Méthode URI de demande
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}

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
timeout integer (int64) Non Requête
IncludeHealthState boolean 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.1

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

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.

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.

IncludeHealthState

Type : booléen
Obligatoire : Non
Par défaut : false

Inclut l’état d’intégrité d’une entité. Si ce paramètre est défini sur false ou n’est pas spécifié, l’état d’intégrité retourné est « Inconnu ». Lorsque la valeur est true, la requête s’applique en parallèle au nœud et au service système d’intégrité avant la fusion des résultats. Par conséquent, la requête est plus coûteuse et peut prendre plus de temps.

Réponses

Code d’état HTTP Description Schéma de réponse
200 (OK) Une opération réussie retourne 200 status code et les informations sur l’application déployée.
 DeployedApplicationInfo
204 (NoContent) Une réponse vide est retournée si l’application spécifiée n’est pas déployée sur le nœud.
Tous les autres codes status Réponse d’erreur détaillée.
 FabricError

Exemples

Obtenir une application déployée spécifique par ID d’application et inclure l’état d’intégrité dans le résultat

Cet exemple montre comment obtenir des informations sur une application déployée sur un nœud spécifié à l’aide d’un identificateur d’application. Si l’application est trouvée, ses informations sont retournées avec 200 status code. Une réponse vide avec status code 204 est retournée si l’application spécifiée n’est pas déployée sur le nœud.

Requête

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True

Réponse 200

Corps
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0.0",
  "Status": "Active",
  "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
  "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
  "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
  "HealthState": "Ok"
}

Réponse 204

Corps

Le corps de la réponse est vide.