Obtención del estado del clúster
Obtiene el estado de un clúster de Service Fabric.
Use EventsHealthStateFilter para filtrar la colección de eventos de estado notificados en el clúster en función del estado de mantenimiento. Asimismo, utilice NodesHealthStateFilter y ApplicationsHealthStateFilter para filtrar la colección de nodos y aplicaciones devueltas, según su estado de mantenimiento agregado.
Solicitud
| Método | URI de solicitud |
|---|---|
| GET | /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout} |
Parámetros
| Nombre | Tipo | Requerido | Location |
|---|---|---|---|
api-version |
string | Sí | Consultar |
NodesHealthStateFilter |
integer | No | Consultar |
ApplicationsHealthStateFilter |
integer | No | Consultar |
EventsHealthStateFilter |
integer | No | Consultar |
ExcludeHealthStatistics |
boolean | No | Consultar |
IncludeSystemApplicationHealthStatistics |
boolean | No | Consultar |
timeout |
entero (int64) | 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.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.
NodesHealthStateFilter
Tipo: entero
Obligatoria: no
Predeterminado:
Permite filtrar los objetos de estado de mantenimiento de nodos devueltos en el resultado de la consulta de mantenimiento del clúster 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 nodos que coinciden con el filtro. Todos los nodos 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 nodos 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.
ApplicationsHealthStateFilter
Tipo: entero
Obligatoria: no
Predeterminado:
Permite el filtrado de los objetos de estado de mantenimiento de aplicaciones devueltos en el resultado de la consulta de mantenimiento del clúster en función de su estado de mantenimiento.
Los valores posibles para este parámetro incluyen un valor entero obtenido de los miembros u operaciones bit a bit en miembros de la enumeración HealthStateFilter. Solo se devuelven las aplicaciones que coinciden con el filtro.
Todas las aplicaciones se usan 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 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.
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.
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.
IncludeSystemApplicationHealthStatistics
Tipo: booleano
Obligatoria: no
Predeterminado:
Indica si las estadísticas de mantenimiento deben incluir las estadísticas de mantenimiento de aplicaciones fabric:/System. El valor predeterminado es false.
Si IncludeSystemApplicationHealthStatistics se establece en true, las estadísticas de estado incluyen las entidades que pertenecen a la aplicación fabric:/System.
En caso contrario, el resultado de la consulta incluye las estadísticas de estado solo para las aplicaciones de usuario.
Las estadísticas de mantenimiento deben incluirse en el resultado de la consulta para que se aplique este parámetro.
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 mantenimiento del clúster solicitada. |
ClusterHealth |
| Todos los demás códigos de estado | Respuesta de error detallada. |
FabricError |