Obtener lista de eventos de aplicaciones

  • Artículo

Obtiene los eventos relacionados con todas las aplicaciones.

La respuesta es una lista de objetos ApplicationEvent.

Solicitud

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

Parámetros

Nombre Tipo Requerido Location
api-version string Sí Consultar
timeout entero (int64) No Consultar
StartTimeUtc string Sí Consultar
EndTimeUtc string Sí Consultar
EventsTypesFilter string No Consultar
ExcludeAnalysisEvents boolean No Consultar
SkipCorrelationLookup boolean No Consultar

api-version

Tipo: cadena
Obligatoria: sí
Predeterminado:

La versión de la API. Este parámetro es necesario y su valor debe ser "6.4".

La versión de la API rest de Service Fabric se basa en la versión en tiempo de ejecución en la que se introdujo o se cambió la API. El entorno de ejecución de Service Fabric admite más de una versión de la API. Esta versión es la versión más reciente admitida de la API. Si se pasa una versión de API inferior, la respuesta devuelta puede ser diferente de la documentada en esta especificación.

Además, el tiempo de ejecución acepta cualquier versión superior a la versión admitida más reciente hasta la versión actual del entorno de ejecución. Por lo tanto, si la versión más reciente de la API es 6.0 y el runtime es 6.1, el entorno de ejecución aceptará la versión 6.1 para esa API. Sin embargo, el comportamiento de la API será según la versión 6.0 documentada.

timeout

Tipo: entero (int64)
Obligatoria: no
Predeterminado:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Tiempo de espera del servidor para realizar la operación en segundos. Este tiempo de espera especifica el tiempo que el cliente está dispuesto a esperar a que se complete la operación solicitada. El valor predeterminado para este parámetro es 60 segundos.

StartTimeUtc

Tipo: cadena
Obligatoria: sí

Hora de inicio de una consulta de búsqueda en ISO UTC aaaa-MM-ddHH:mm:ssZ.

EndTimeUtc

Tipo: cadena
Obligatoria: sí

Hora de finalización de una consulta de búsqueda en ISO UTC aaaa-MM-ddHH:mm:ssZ.

EventsTypesFilter

Tipo: cadena
Obligatoria: no

Se trata de una cadena separada por comas que especifica los tipos de FabricEvents que solo deben incluirse en la respuesta.

ExcludeAnalysisEvents

Tipo: booleano
Obligatoria: no

Este parámetro deshabilita la recuperación de AnalysisEvents si se pasa true.

SkipCorrelationLookup

Tipo: booleano
Obligatoria: no

Este parámetro deshabilita la búsqueda de información de CorrelatedEvents si se pasa true. En otro caso, se procesa CorrelationEvents y se rellena el campo HasCorrelatedEvents de cada FabricEvent.

Respuestas

Código de estado HTTP Descripción Esquema de respuesta
200 (OK) Lista de objetos de eventos con el tipo base ApplicationEvent.
 matriz de ApplicationEvent
Todos los demás códigos de estado Respuesta de error detallada.
 FabricError

Ejemplos

En este ejemplo se muestra cómo obtener todos los eventos relacionados con las aplicaciones durante un período de tiempo determinado.

Request

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

Respuesta 200

Cuerpo
[
  {
    "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
  },
  {
    "Kind": "ApplicationCreated",
    "ApplicationTypeName": "App2Type",
    "ApplicationTypeVersion": "4.0.1",
    "ApplicationDefinitionKind": "ServiceFabricApplicationDescription",
    "ApplicationId": "app2",
    "EventInstanceId": "d50574bc-6a31-4945-8275-7639bec7a0b3",
    "TimeStamp": "2018-04-03T20:21:59.74842Z",
    "HasCorrelatedEvents": false
  }
]