Obtención del estado de la aplicación mediante la directiva
Obtiene el estado de una aplicación de Service Fabric mediante la directiva especificada.
Obtiene el estado de una aplicación de Service Fabric. Use EventsHealthStateFilter para filtrar la colección de eventos de estado notificados en el nodo en función del estado de mantenimiento. Use ClusterHealthPolicies para invalidar las directivas de mantenimiento usadas para evaluar el estado.
Solicitud
| Método | URI de solicitud |
|---|---|
| POST | /Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parámetros
| Nombre | Tipo | Requerido | Location |
|---|---|---|---|
applicationId |
string | Sí | Ruta de acceso |
api-version |
string | Sí | Consultar |
EventsHealthStateFilter |
integer | No | Consultar |
DeployedApplicationsHealthStateFilter |
integer | No | Consultar |
ServicesHealthStateFilter |
integer | No | Consultar |
ExcludeHealthStatistics |
boolean | No | Consultar |
timeout |
entero (int64) | No | Consultar |
ApplicationHealthPolicy |
ApplicationHealthPolicy | No | Cuerpo |
applicationId
Tipo: cadena
Obligatoria: sí
La identidad de la aplicación. Este suele ser el nombre completo de la aplicación sin el esquema de URI "fabric:"
A partir de la versión 6.0, los nombres jerárquicos se delimitan con el carácter "~".
Por ejemplo, si el nombre de la aplicación es "fabric:/myapp/app1", la identidad de la aplicación sería "myapp~app1" en 6.0+ y "myapp/app1" en las versiones anteriores.
api-version
Tipo: cadena
Obligatoria: sí
Predeterminado:
La versión de la API. Este parámetro es necesario y su valor debe ser "6.0".
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 es la versión compatible más reciente de la API. Si se pasa una versión de API anterior, 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 compatible 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, pero si el tiempo de ejecución es 6.1, para facilitar la escritura de los clientes, 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 documentada 6.0.
EventsHealthStateFilter
Tipo: entero
Obligatoria: no
Predeterminado:
Permite filtrar la colección de objetos HealthEvent devueltos según el estado de mantenimiento.
Los valores posibles para este parámetro incluyen el valor entero de uno de los siguientes estados de mantenimiento.
Se devuelven únicamente los eventos que coinciden con el filtro. Todos los eventos se utilizan para evaluar el estado de mantenimiento agregado.
Si no se especifica, se devuelven todas las entradas. Los valores de estado se marcan según la enumeración, por lo que el valor puede ser una combinación de estos valores obtenidos mediante el operador bit a bit "OR". Por ejemplo, si el valor proporcionado es 6, se devuelven todos los eventos con el valor HealthState de Ok (2) y Warning (4).
- Valor predeterminado: valor predeterminado. Coincide con cualquier HealthState. El valor predeterminado es cero.
- Ninguno: filtro que no coincide con ningún valor healthState. Se utiliza para no devolver ningún resultado en una determinada colección de estados. El valor es 1.
- Ok: filtro que coincide con la entrada con el valor HealthState Ok. El valor es 2.
- Advertencia: filtro que coincide con la entrada con el valor HealthState Advertencia. El valor es 4.
- Error: filtro que coincide con la entrada con el valor HealthState Error. El valor es 8.
- All: filtro que coincide con la entrada con cualquier valor HealthState. El valor es 65535.
DeployedApplicationsHealthStateFilter
Tipo: entero
Obligatoria: no
Predeterminado:
Permite filtrar los objetos de estado de mantenimiento de las aplicaciones implementadas devueltos en el resultado de la consulta de mantenimiento de las aplicaciones según su estado de mantenimiento.
Los valores posibles para este parámetro incluyen el valor entero de uno de los siguientes estados de mantenimiento. Solo se devolverán las aplicaciones implementadas que coincidan con el filtro.
Todas las aplicaciones implementadas se utilizan para evaluar el estado de mantenimiento agregado. Si no se especifica, se devuelven todas las entradas.
Los valores de estado se marcan según la enumeración, por lo que el valor puede ser una combinación de estos valores obtenidos mediante el operador bit a bit "OR".
Por ejemplo, si el valor proporcionado es 6, se devuelve el estado de mantenimiento de las aplicaciones implementadas con el valor HealthState de Ok (2) y Warning (4).
- Valor predeterminado: valor predeterminado. Coincide con cualquier HealthState. El valor predeterminado es cero.
- Ninguno: filtro que no coincide con ningún valor healthState. Se utiliza para no devolver ningún resultado en una determinada colección de estados. El valor es 1.
- Ok: filtro que coincide con la entrada con el valor HealthState Ok. El valor es 2.
- Advertencia: filtro que coincide con la entrada con el valor HealthState Advertencia. El valor es 4.
- Error: filtro que coincide con la entrada con el valor HealthState Error. El valor es 8.
- All: filtro que coincide con la entrada con cualquier valor HealthState. El valor es 65535.
ServicesHealthStateFilter
Tipo: entero
Obligatoria: no
Predeterminado:
Permite filtrar los objetos de estado de mantenimiento de los servicios devueltos en el resultado del la consulta de mantenimiento de los servicios en función de su estado de mantenimiento.
Los valores posibles para este parámetro incluyen el valor entero de uno de los siguientes estados de mantenimiento.
Se devuelven únicamente los servicios que coinciden con el filtro. Todos los servicios se utilizan para evaluar el estado de mantenimiento agregado.
Si no se especifica, se devuelven todas las entradas. Los valores de estado se marcan según la enumeración, por lo que el valor puede ser una combinación de estos valores obtenidos mediante el operador bit a bit "OR". Por ejemplo, si el valor proporcionado es 6, se devuelve el estado de mantenimiento de los servicios con el valor HealthState de Ok (2) y Warning (4).
- Valor predeterminado: valor predeterminado. Coincide con cualquier HealthState. El valor predeterminado es cero.
- Ninguno: filtro que no coincide con ningún valor healthState. Se utiliza para no devolver ningún resultado en una determinada colección de estados. El valor es 1.
- Ok: filtro que coincide con la entrada con el valor HealthState Ok. El valor es 2.
- Advertencia: filtro que coincide con la entrada con el valor HealthState Advertencia. El valor es 4.
- Error: filtro que coincide con la entrada con el valor HealthState Error. El valor es 8.
- All: filtro que coincide con la entrada con cualquier valor HealthState. El valor es 65535.
ExcludeHealthStatistics
Tipo: booleano
Obligatoria: no
Predeterminado:
Indica si las estadísticas de mantenimiento se deben devolver como parte del resultado de la consulta. El valor predeterminado es false.
Las estadísticas muestran el número de entidades secundarias en estado de mantenimiento Ok, Warning y Error.
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.
ApplicationHealthPolicy
Tipo: ApplicationHealthPolicy
Obligatoria: no
Describe las directivas de mantenimiento usadas para evaluar el estado de una aplicación o uno de sus elementos secundarios.
Si no está presente, la evaluación de estado usa la directiva de mantenimiento del manifiesto de aplicación o la directiva de mantenimiento predeterminada.
Respuestas
| Código de estado HTTP | Descripción | Esquema de respuesta |
|---|---|---|
| 200 (OK) | Una operación correcta devolverá el código de estado 200 y la información de mantenimiento del nodo solicitada. |
ApplicationHealth |
| Todos los demás códigos de estado | Respuesta de error detallada. |
FabricError |