Obter a integridade do cluster usando a política
Obtém a integridade de um cluster do Service Fabric usando a política especificada.
Use EventsHealthStateFilter para filtrar o conjunto de eventos de integridade relatados no cluster de acordo com o estado de integridade. Da mesma forma, use NodesHealthStateFilter e ApplicationsHealthStateFilter para filtrar o conjunto de nós e aplicativos retornados com base no seu estado de integridade agregada. Use ClusterHealthPolicies para substituir as políticas de integridade usadas para avaliar a integridade.
Solicitação
| Método | URI da solicitação |
|---|---|
| POST | /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout} |
Parâmetros
| Nome | Type | Obrigatório | Location |
|---|---|---|---|
api-version |
string | Sim | Consulta |
NodesHealthStateFilter |
inteiro | Não | Consulta |
ApplicationsHealthStateFilter |
inteiro | Não | Consulta |
EventsHealthStateFilter |
inteiro | Não | Consulta |
ExcludeHealthStatistics |
booleano | Não | Consulta |
IncludeSystemApplicationHealthStatistics |
booleano | Não | Consulta |
timeout |
inteiro (int64) | Não | Consulta |
ClusterHealthPolicies |
ClusterHealthPolicies | Não | Corpo |
api-version
Tipo: string
Obrigatório: sim
Padrão: 6.0
A versão da API. Esse parâmetro é necessário e seu valor deve ser '6.0'.
A versão da API REST do Service Fabric baseia-se na versão de runtime na qual a API foi introduzida ou foi alterada. O runtime do Service Fabric dá suporte a mais de uma versão da API. Esta é a versão mais recente com suporte da API. Se uma versão inferior da API for passada, a resposta retornada poderá ser diferente daquela documentada nesta especificação.
Além disso, o runtime aceita qualquer versão que seja maior do que a versão mais recente com suporte até a versão atual do runtime. Portanto, se a versão mais recente da API for 6.0, mas se o runtime for 6.1, para facilitar a gravação dos clientes, o runtime aceitará a versão 6.1 para essa API. No entanto, o comportamento da API será de acordo com a versão documentada 6.0.
NodesHealthStateFilter
Tipo: inteiro
Obrigatório: não
Padrão: 0
Permite filtrar os objetos de estado de integridade de nó retornados no resultado da consulta de integridade do cluster com base em seu estado de integridade. Os valores possíveis para esse parâmetro incluem o valor de inteiro de um dos seguintes estados de integridade. Só retornam os nós que correspondem ao filtro. Todos os nós são usados para avaliar o estado de integridade agregado.
Se não for especificado, retorna todas as entradas.
Os valores de estado são enumerações baseadas no sinalizador. Assim, o valor pode ser uma combinação desses valores obtidos, usando o operador 'OR' bit a bit.
Por exemplo, se o valor fornecido for 6, o estado de integridade dos nós com o valor HealthState de OK (2) e Aviso (4) será retornado.
- Padrão – valor padrão. Corresponde a qualquer HealthState. O valor é zero.
- Nenhum – filtro que não corresponde a nenhum valor de HealthState. Usado para não retornar qualquer resultado em um determinado conjunto de estados. O valor é 1.
- Ok - Filtro que corresponde à entrada com o valor de HealthState Ok. O valor é 2.
- Aviso – filtro que corresponde à entrada com o valor de HealthState Aviso. O valor é 4.
- Erro – filtro que corresponde à entrada com o valor de HealthState Error. O valor é 8.
- Todos – Filtro que corresponde à entrada com qualquer valor HealthState. O valor é 65535.
ApplicationsHealthStateFilter
Tipo: inteiro
Obrigatório: não
Padrão: 0
Permite filtrar os objetos de estado de integridade do aplicativo retornados no resultado da consulta de integridade do cluster com base em seu estado de integridade.
Os valores possíveis para este parâmetro incluem valor inteiro obtido de membros ou operações bit a bit em membros da enumeração HealthStateFilter. São retornados apenas aplicativos que correspondem ao filtro.
Todos os aplicativos são usados para avaliar o estado de integridade agregada. Se não for especificado, retorna todas as entradas.
Os valores de estado são enumerações baseadas no sinalizador. Assim, o valor pode ser uma combinação desses valores obtidos, usando o operador 'OR' bit a bit.
Por exemplo, se o valor fornecido for 6, o estado de integridade dos aplicativos com valor HealthState de OK (2) e Aviso (4) será retornado.
- Padrão – valor padrão. Corresponde a qualquer HealthState. O valor é zero.
- Nenhum – filtro que não corresponde a nenhum valor de HealthState. Usado para não retornar qualquer resultado em um determinado conjunto de estados. O valor é 1.
- Ok - Filtro que corresponde à entrada com o valor de HealthState Ok. O valor é 2.
- Aviso – filtro que corresponde à entrada com o valor de HealthState Aviso. O valor é 4.
- Erro – filtro que corresponde à entrada com o valor de HealthState Error. O valor é 8.
- Todos – Filtro que corresponde à entrada com qualquer valor HealthState. O valor é 65535.
EventsHealthStateFilter
Tipo: inteiro
Obrigatório: não
Padrão: 0
Permite filtrar a coleção de objetos HealthEvent retornados com base no estado de integridade.
Os valores possíveis para esse parâmetro incluem o valor de inteiro de um dos seguintes estados de integridade.
Somente os eventos que correspondem ao filtro são retornados. Todos os eventos são usados para avaliar o estado de integridade agregado.
Se não for especificado, retorna todas as entradas. Os valores de estado são enumerações baseadas no sinalizador. Assim, o valor pode ser uma combinação desses valores obtidos, usando o operador “OR” bit a bit. Por exemplo, se o valor fornecido for 6, serão retornados todos os eventos com o valor de HealthState de OK (2) e de Aviso (4).
- Padrão – valor padrão. Corresponde a qualquer HealthState. O valor é zero.
- Nenhum – filtro que não corresponde a nenhum valor de HealthState. Usado para não retornar qualquer resultado em um determinado conjunto de estados. O valor é 1.
- Ok - Filtro que corresponde à entrada com o valor de HealthState Ok. O valor é 2.
- Aviso – filtro que corresponde à entrada com o valor de HealthState Aviso. O valor é 4.
- Erro – filtro que corresponde à entrada com o valor de HealthState Error. O valor é 8.
- Todos – Filtro que corresponde à entrada com qualquer valor HealthState. O valor é 65535.
ExcludeHealthStatistics
Tipo: booliano
Obrigatório: não
Padrão: false
Indica se as estatísticas de integridade devem ser retornadas como parte do resultado da consulta. Falso por padrão.
As estatísticas mostram o número de entidades filhas nos estados de integridade Ok, Warning e Error.
IncludeSystemApplicationHealthStatistics
Tipo: booliano
Obrigatório: não
Padrão: false
Indica se as estatísticas de integridade devem incluir as estatísticas de integridade do aplicativo fabric:/System. Falso por padrão.
Se IncludeSystemApplicationHealthStatistics for definido como true, a integridade estatística inclui as entidades que pertencem à malha: / aplicativo do sistema.
Caso contrário, o resultado da consulta inclui estatísticas de integridade somente para aplicativos de usuário.
As estatísticas de integridade devem ser incluídas no resultado da consulta para que este parâmetro seja aplicado.
timeout
Tipo: inteiro (int64)
Obrigatório: não
Padrão: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
Tempo limite do servidor para executar a operação em segundos. Especifica o tempo que o cliente está disposto a esperar para que operação solicitada seja concluída. O valor padrão desse parâmetro é 60 segundos.
ClusterHealthPolicies
Tipo: ClusterHealthPolicies
Obrigatório: não
Descreve as políticas de integridade usadas para avaliar a integridade do cluster.
Se não estiver presente, a avaliação de integridade usará a política de integridade do cluster definida no manifesto do cluster ou na política de integridade do cluster padrão.
Por padrão, cada aplicativo é avaliado usando sua política de integridade de aplicativo específica, definida no manifesto do aplicativo ou a política de integridade padrão, se nenhuma política for definida no manifesto.
Se o mapa da política de integridade do aplicativo for especificado e tiver uma entrada para um aplicativo, a política de integridade do aplicativo especificada será usada para avaliar a integridade do aplicativo.
Respostas
| Código de status HTTP | Descrição | Esquema de Resposta |
|---|---|---|
| 200 (OK) | Uma operação bem-sucedida retornará 200 status código e as informações de integridade do cluster solicitadas. |
ClusterHealth |
| Todos os outros códigos de status | A resposta de erro detalhada. |
FabricError |