Partilhar via

Obter Estado de Funcionamento do Cluster

  • Artigo

Obtém o estado de funcionamento de um cluster do Service Fabric.

Utilize EventsHealthStateFilter para filtrar a coleção de eventos de estado de funcionamento comunicados no cluster com base no estado de funcionamento. Da mesma forma, utilize NodesHealthStateFilter e ApplicationsHealthStateFilter para filtrar a coleção de nós e aplicações devolvidos com base no estado de funcionamento agregado.

Pedir

Método URI do pedido
GET /$/GetClusterHealth?api-version=6.0&NodesHealthStateFilter={NodesHealthStateFilter}&ApplicationsHealthStateFilter={ApplicationsHealthStateFilter}&EventsHealthStateFilter={EventsHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&IncludeSystemApplicationHealthStatistics={IncludeSystemApplicationHealthStatistics}&timeout={timeout}

Parâmetros

Nome Tipo Necessário Localização
api-version string Yes Consulta
NodesHealthStateFilter número inteiro No Consulta
ApplicationsHealthStateFilter número inteiro No Consulta
EventsHealthStateFilter número inteiro No Consulta
ExcludeHealthStatistics boolean No Consulta
IncludeSystemApplicationHealthStatistics boolean No Consulta
timeout número inteiro (int64) No Consulta

api-version

Tipo: cadeia
Obrigatório: Sim
Predefinição: 6.0

A versão da API. Este parâmetro é obrigatório e o respetivo valor tem de 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 alterada. O runtime do Service Fabric suporta mais do que uma versão da API. Esta é a versão suportada mais recente da API. Se for transmitida uma versão inferior da API, a resposta devolvida poderá ser diferente da documentada nesta especificação.

Além disso, o runtime aceita qualquer versão superior à versão suportada mais recente até à versão atual do runtime. Por isso, se a versão mais recente da API for a 6.0, mas se o runtime for 6.1, para facilitar a escrita 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 6.0 documentada.

NodesHealthStateFilter

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

Permite a filtragem dos objetos de estado de funcionamento do nó devolvidos no resultado da consulta de estado de funcionamento do cluster com base no estado de funcionamento. Os valores possíveis para este parâmetro incluem o valor inteiro de um dos seguintes estados de funcionamento. Só são devolvidos os nós que correspondem ao filtro. Todos os nós são utilizados para avaliar o estado de funcionamento agregado. Se não for especificado, todas as entradas são devolvidas. Os valores de estado são uma enumeração baseada em sinalizadores, pelo que o valor pode ser uma combinação destes valores obtidos com o operador bit-a-bit "OR". Por exemplo, se o valor fornecido for 6, será devolvido o estado de funcionamento dos nós com o valor HealthState de OK (2) e Aviso (4).

  • Predefinição – valor predefinido. Corresponde a qualquer HealthState. O valor é zero.
  • Nenhum – filtro que não corresponde a nenhum valor healthState. Utilizado para não devolver resultados numa determinada coleção de estados. O valor é 1.
  • OK - Filtro que corresponde à entrada com o valor HealthState OK. O valor é 2.
  • Aviso – filtro que corresponde à entrada com o valor HealthState Aviso. O valor é 4.
  • Erro – filtro que corresponde à entrada com o valor HealthState Erro. O valor é 8.
  • All - filtro que corresponde à entrada com qualquer valor HealthState. O valor é 65535.

ApplicationsHealthStateFilter

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

Permite a filtragem dos objetos de estado de funcionamento da aplicação devolvidos no resultado da consulta de estado de funcionamento do cluster com base no respetivo estado de funcionamento. Os valores possíveis para este parâmetro incluem o valor inteiro obtido a partir de membros ou operações bit-a-bit nos membros da enumeração HealthStateFilter. Só são devolvidas as aplicações que correspondem ao filtro. Todas as aplicações são utilizadas para avaliar o estado de funcionamento agregado. Se não for especificado, todas as entradas são devolvidas. Os valores de estado são uma enumeração baseada em sinalizadores, pelo que o valor pode ser uma combinação destes valores obtidos com o operador bit-a-bit "OR". Por exemplo, se o valor fornecido for 6, será devolvido o estado de funcionamento das aplicações com o valor HealthState de OK (2) e Aviso (4).

  • Predefinição – valor predefinido. Corresponde a qualquer HealthState. O valor é zero.
  • Nenhum – filtro que não corresponde a nenhum valor healthState. Utilizado para não devolver resultados numa determinada coleção de estados. O valor é 1.
  • OK - Filtro que corresponde à entrada com o valor HealthState OK. O valor é 2.
  • Aviso – filtro que corresponde à entrada com o valor HealthState Aviso. O valor é 4.
  • Erro – filtro que corresponde à entrada com o valor HealthState Erro. O valor é 8.
  • All - filtro que corresponde à entrada com qualquer valor HealthState. O valor é 65535.

EventsHealthStateFilter

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

Permite filtrar a coleção de objetos HealthEvent devolvidos com base no estado de funcionamento. Os valores possíveis para este parâmetro incluem o valor inteiro de um dos seguintes estados de estado de funcionamento. Só são devolvidos eventos que correspondam ao filtro. Todos os eventos são utilizados para avaliar o estado de funcionamento agregado. Se não for especificado, todas as entradas são devolvidas. Os valores de estado são enumeração baseada em sinalizador, pelo que o valor pode ser uma combinação destes valores, obtida com o operador "OR" bit-a-bit. Por exemplo, se o valor fornecido for 6, todos os eventos com o valor HealthState de OK (2) e Aviso (4) são devolvidos.

  • Predefinição - Valor predefinido. Corresponde a qualquer Estado de Funcionamento. O valor é zero.
  • Nenhum - Filtro que não corresponde a nenhum valor HealthState. Utilizado para não devolver resultados numa determinada coleção de estados. O valor é 1.
  • Ok - Filtrar que corresponde à entrada com o valor HealthState Ok. O valor é 2.
  • Aviso – filtro que corresponde à entrada com o valor HealthState Aviso. O valor é 4.
  • Erro – filtro que corresponde à entrada com o valor HealthState Erro. O valor é 8.
  • All - Filtrar que corresponde à entrada com qualquer valor HealthState. O valor é 65535.

ExcludeHealthStatistics

Tipo: booleano
Obrigatório: Não
Predefinição: false

Indica se as estatísticas de estado de funcionamento devem ser devolvidas como parte do resultado da consulta. Falso por predefinição. As estatísticas mostram o número de entidades subordinadas no estado de funcionamento Ok, Aviso e Erro.

IncludeSystemApplicationHealthStatistics

Tipo: booleano
Obrigatório: Não
Predefinição: false

Indica se as estatísticas de estado de funcionamento devem incluir as estatísticas de estado de funcionamento da aplicação de recursos de infraestrutura:/Sistema. Falso por predefinição. Se IncludeSystemApplicationHealthStatistics estiver definido como verdadeiro, as estatísticas de estado de funcionamento incluem as entidades que pertencem à aplicação fabric:/System. Caso contrário, o resultado da consulta inclui estatísticas de estado de funcionamento apenas para aplicações de utilizador. As estatísticas de estado de funcionamento têm de ser incluídas no resultado da consulta para que este parâmetro seja aplicado.

timeout

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

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

Respostas

Código de Estado HTTP Description Esquema de Resposta
200 (OK) Uma operação bem-sucedida devolverá o código de estado 200 e as informações de estado de funcionamento do cluster pedidas.
 ClusterHealth
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError