Obtención del fragmento de estado del clúster mediante filtros avanzados y directivas
Obtiene el estado de un clúster de Service Fabric mediante fragmentos de estado.
Obtiene el estado de un clúster de Service Fabric mediante fragmentos de estado. La evaluación de estado se realiza en función de la descripción de la consulta del fragmento de estado del clúster de entrada. La descripción de la consulta permite a los usuarios especificar directivas de mantenimiento para evaluar el clúster y sus elementos secundarios. Los usuarios pueden especificar filtros muy flexibles para seleccionar las entidades de clúster que se van a devolver. La selección se puede realizar en función del estado de mantenimiento de las entidades y en función de la jerarquía. La consulta puede devolver elementos secundarios de varios niveles de las entidades en función de los filtros especificados. Por ejemplo, puede devolver una aplicación con un nombre especificado y, para esta aplicación, devolver solo los servicios que se encuentran en Error o Advertencia, y todas las particiones y réplicas de uno de estos servicios.
Solicitud
| Método | URI de solicitud |
|---|---|
| POST | /$/GetClusterHealthChunk?api-version=6.0&timeout={timeout} |
Parámetros
| Nombre | Tipo | Requerido | Location |
|---|---|---|---|
api-version |
string | Sí | Consultar |
timeout |
entero (int64) | No | Consultar |
ClusterHealthChunkQueryDescription |
ClusterHealthChunkQueryDescription | No | Cuerpo |
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.
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.
ClusterHealthChunkQueryDescription
Tipo: ClusterHealthChunkQueryDescription
Obligatoria: no
Describe las directivas de mantenimiento del clúster y de la aplicación que se usan para evaluar el estado del clúster y los filtros para seleccionar las entidades de clúster que se van a devolver.
Si la directiva de mantenimiento del clúster está presente, se usa para evaluar los eventos del clúster y los nodos del clúster. Si no está presente, la evaluación de estado usa la directiva de mantenimiento del clúster definida en el manifiesto del clúster o la directiva de mantenimiento del clúster predeterminada.
De forma predeterminada, cada aplicación se evalúa mediante su directiva de estado de aplicación específica, definida en el manifiesto de aplicación o la directiva de mantenimiento predeterminada, si no se define ninguna directiva en el manifiesto.
Si se especifica el mapa de directivas de mantenimiento de la aplicación y tiene una entrada para una aplicación, la directiva de mantenimiento de la aplicación especificada se usa para evaluar el estado de la aplicación.
Los usuarios pueden especificar filtros muy flexibles para seleccionar qué entidades de clúster se van a incluir en respuesta. La selección se puede realizar en función del estado de mantenimiento de las entidades y en función de la jerarquía.
La consulta puede devolver elementos secundarios de varios niveles de las entidades en función de los filtros especificados. Por ejemplo, puede devolver una aplicación con un nombre especificado y, para esta aplicación, devolver solo los servicios que se encuentran en Error o Advertencia, y todas las particiones y réplicas de uno de estos servicios.
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 del fragmento de estado del clúster solicitada. |
ClusterHealthChunk |
| Todos los demás códigos de estado | Respuesta de error detallada. |
FabricError |