Partager via

Obtenir la liste des événements d’application

  • Article

Obtient un événement lié à une application.

La réponse est une liste d’objets ApplicationEvent.

Requête

Méthode URI de demande
GET /EventsStore/Applications/{applicationId}/$/Events?api-version=6.4&timeout={timeout}&StartTimeUtc={StartTimeUtc}&EndTimeUtc={EndTimeUtc}&EventsTypesFilter={EventsTypesFilter}&ExcludeAnalysisEvents={ExcludeAnalysisEvents}&SkipCorrelationLookup={SkipCorrelationLookup}

Paramètres

Nom Type Obligatoire Emplacement
applicationId string Oui Chemin d’accès
api-version string Oui Requête
timeout integer (int64) Non Requête
StartTimeUtc string Oui Requête
EndTimeUtc string Oui Requête
EventsTypesFilter string Non Requête
ExcludeAnalysisEvents boolean Non Requête
SkipCorrelationLookup boolean 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.

api-version

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

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

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. Cette version est 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 et que le runtime est 6.1, 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.

StartTimeUtc

Type : chaîne
Obligatoire : Oui

Heure de début d’une requête de recherche en ISO UTC aaaa-MM-jjTHH:mm:ssZ.

EndTimeUtc

Type : chaîne
Obligatoire : Oui

Heure de fin d’une requête de recherche en ISO UTC aaaa-MM-jjTHH:mm:ssZ.

EventsTypesFilter

Type : chaîne
Obligatoire : Non

Chaîne séparée par des virgules spécifiant les types de FabricEvents qui doivent être inclus uniquement dans la réponse.

ExcludeAnalysisEvents

Type : booléen
Obligatoire : Non

Ce paramètre désactive la récupération d’AnalysisEvents si la valeur true est transmise.

SkipCorrelationLookup

Type : booléen
Obligatoire : Non

Ce paramètre désactive la recherche d’informations CorrelatedEvents si la valeur true est transmise. Dans le cas contraire, CorrelationEvents est traité et le champ HasCorrelatedEvents dans chaque FabricEvent est rempli.

Réponses

Code d’état HTTP Description Schéma de réponse
200 (OK) Liste d’objets d’événements avec le type de base ApplicationEvent.
 tableau d’ApplicationEvent
Tous les autres codes status Réponse d’erreur détaillée.
 FabricError

Exemples

Cet exemple montre comment obtenir tous les événements liés à l’application pendant une certaine fenêtre de temps.

Requête

GET http://localhost:19080/EventsStore/Applications/app1/$/Events?api-version=6.4&StartTimeUtc=2018-04-03T18:00:00Z&EndTimeUtc=2018-04-04T18:00:00Z

Réponse 200

Corps
[
  {
    "Kind": "ApplicationCreated",
    "ApplicationTypeName": "App1Type",
    "ApplicationTypeVersion": "1.0.1",
    "ApplicationDefinitionKind": "ServiceFabricApplicationDescription",
    "ApplicationId": "app1",
    "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10",
    "TimeStamp": "2018-04-03T20:21:23.5774199Z",
    "HasCorrelatedEvents": false
  }
]