Obter réplica saúde usando a política

Obtém a saúde de uma réplica de serviço Service Fabric ou de serviço apátrida usando a política especificada.

Obtém a saúde de uma réplica de serviço Service Fabric ou de serviço apátrida. Use EventosHealthStateFilter para filtrar a recolha de eventos de saúde relatados no cluster com base no estado de saúde. Use aplicaçãoHealthPolicy para substituir opcionalmente as políticas de saúde usadas para avaliar a saúde. Esta API utiliza apenas o campo 'ConsidereWarningAsError' da AplicaçãoHealthPolicy. O resto dos campos são ignorados enquanto avaliam a saúde da réplica.

Pedir

Método URI do pedido
POST /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

Parâmetros

Nome Tipo Necessário Localização
partitionId corda (uuid) Yes Caminho
replicaId string Yes Caminho
api-version string Sim Consulta
EventsHealthStateFilter número inteiro No Consulta
timeout inteiro (int64) Não Consulta
ApplicationHealthPolicy Política de AplicaçãoHealthPolicy Não Corpo

partitionId

Tipo: cadeia (uuid)
Requerido: Sim

A identidade da divisão.


replicaId

Tipo: corda
Requerido: Sim

O identificador da réplica.


api-version

Tipo: corda
Requerido: Sim
Predefinição: 6.0

A versão da API. Este parâmetro é necessário e o seu valor deve ser '6.0'.

Service Fabric versão REST API baseia-se na versão de tempo de execução em que a API foi introduzida ou alterada. Service Fabric tempo de funcionação suporta mais de uma versão da API. Esta é a mais recente versão suportada da API. Se uma versão API mais baixa for aprovada, a resposta devolvida pode ser diferente da documentada nesta especificação.

Além disso, o tempo de execução aceita qualquer versão superior à versão mais recente suportada até à versão atual do tempo de execução. Portanto, se a versão mais recente da API for 6.0, mas se o tempo de execução for 6.1, de forma a facilitar a escrita dos clientes, o tempo de execução aceitará a versão 6.1 para a API. No entanto, o comportamento da API será conforme a versão 6.0 documentada.


EventsHealthStateFilter

Tipo: inteiro
Obrigatório: Não
Predefinição: 0

Permite filtrar a recolha de objetos HealthEvent devolvidos com base no estado de saúde. Os valores possíveis para este parâmetro incluem o valor inteiro de um dos seguintes estados de saúde. Apenas os eventos que correspondem ao filtro são devolvidos. Todos os eventos são usados para avaliar o estado de saúde agregado. Se não for especificado, todas as entradas são devolvidas. Os valores do Estado são enumeração baseada em bandeiras, pelo que o valor pode ser uma combinação destes valores, obtidos utilizando o operador bitwise 'OR'. Por exemplo, Se o valor fornecido for 6, então todos os eventos com o valor healthState de OK (2) e Aviso (4) são devolvidos.

  • Predefinição - Valor predefinido. Corresponde a qualquer Estado da Saúde. O valor é zero.
  • Nenhum - Filtro que não corresponde a qualquer valor do HealthState. Usado para não devolver resultados numa determinada coleção de estados. O valor é 1.
  • Ok - Filtro que combine com a entrada com o valor healthState Ok. O valor é 2.
  • Aviso - Filtro que corresponda à entrada com o valor healthState Aviso. O valor é 4.
  • Erro - Filtro que corresponde à entrada com Erro de Valor Do Estado do Saúde. O valor é 8.
  • Tudo - Filtrar que corresponda à entrada com qualquer valor healthState. O valor é 65535.

timeout

Tipo: inteiro (int64)
Obrigatório: Não
Predefinição: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

O tempo limite do servidor para a realização da operação em segundos. Este prazo especifica a duração que o cliente está disposto a esperar pela conclusão da operação solicitada. O valor predefinido para este parâmetro é de 60 segundos.


ApplicationHealthPolicy

Tipo: AplicaçãoHealthPolicy
Obrigatório: Não

Descreve as políticas de saúde usadas para avaliar a saúde de uma aplicação ou de um dos seus filhos. Se não estiver presente, a avaliação de saúde utiliza a política de saúde do manifesto de aplicação ou da política de saúde padrão.

Respostas

Código de Estado HTTP Descrição Esquema de Resposta
200 (OK) Uma operação bem sucedida devolverá 200 códigos de estado e a informação de saúde de réplica solicitada.
ReplicaHealth
Todos os outros códigos de estado A resposta detalhada ao erro.
FabricError