Obtención del estado de la aplicación implementado
Obtiene la información sobre el mantenimiento de una aplicación implementada en un nodo de Service Fabric.
Obtiene la información sobre el mantenimiento de una aplicación implementada en un nodo de Service Fabric. Utilice el parámetro EventsHealthStateFilter para filtrar opcionalmente para la colección de objetos HealthEvent notificados en la aplicación implementada según el estado de mantenimiento. Utilice el parámetro DeployedServicePackagesHealthStateFilter para filtrar opcionalmente para los elementos secundarios de DeployedServicePackageHealth según el estado de mantenimiento.
Solicitud
| Método | URI de solicitud |
|---|---|
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedServicePackagesHealthStateFilter={DeployedServicePackagesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parámetros
| Nombre | Tipo | Requerido | Location |
|---|---|---|---|
nodeName |
string | Sí | Ruta de acceso |
applicationId |
string | Sí | Ruta de acceso |
api-version |
string | Sí | Consultar |
EventsHealthStateFilter |
integer | No | Consultar |
DeployedServicePackagesHealthStateFilter |
integer | No | Consultar |
ExcludeHealthStatistics |
boolean | No | Consultar |
timeout |
entero (int64) | No | Consultar |
nodeName
Tipo: cadena
Obligatoria: sí
El nombre del nodo.
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 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, pero si el runtime 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 6.0 documentada.
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.
DeployedServicePackagesHealthStateFilter
Tipo: entero
Obligatoria: no
Predeterminado:
Permite filtrar los objetos de estado de mantenimiento del paquete de servicio implementado devueltos en el resultado de la consulta de mantenimiento de la aplicación implementada 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.
Se devuelven únicamente los paquetes de servicio implementados que coinciden con el filtro. Todos los paquetes de servicio implementados se utilizan para evaluar el estado de mantenimiento agregado de la aplicación implementada.
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 paquetes de servicio 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.
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 estado de la aplicación implementada. |
DeployedApplicationHealth |
| Todos los demás códigos de estado | Respuesta de error detallada. |
FabricError |