Obter política de utilização de saúde de aplicação

Obtém a saúde de uma aplicação de Tecido de Serviço utilizando a política especificada.

Obtém a saúde de uma aplicação de Tecido de Serviço. Use EventsHealthStateFilter para filtrar a recolha de eventos de saúde relatados no nó com base no estado de saúde. Utilize as Políticas de Saúde cluster para anular as políticas de saúde utilizadas para avaliar a saúde.

Pedir

Método URI do pedido
POST /Applications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedApplicationsHealthStateFilter={DeployedApplicationsHealthStateFilter}&ServicesHealthStateFilter={ServicesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}

Parâmetros

Nome Tipo Necessário Localização
applicationId string Sim Caminho
api-version string Sim Consulta
EventsHealthStateFilter número inteiro Não Consulta
DeployedApplicationsHealthStateFilter número inteiro Não Consulta
ServicesHealthStateFilter número inteiro Não Consulta
ExcludeHealthStatistics boolean Não Consulta
timeout inteiro (int64) Não Consulta
ApplicationHealthPolicy Política de Saúde de Aplicações Não Corpo

applicationId

Tipo: corda
Obrigatório: Sim

A identidade do pedido. Este é tipicamente o nome completo da aplicação sem o esquema URI 'fabric:' URI. A partir da versão 6.0, os nomes hierárquicos são delimitados com o caráter "~". Por exemplo, se o nome da aplicação for "tecido:/myapp/app1", a identidade da aplicação seria "myapp~app1" em 6.0+ e "myapp/app1" em versões anteriores.


api-version

Tipo: corda
Obrigatório: Sim
Padrão:6.0

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

A versão API do Service Fabric REST baseia-se na versão tempo de execução em que a API foi introduzida ou foi alterada. O tempo de execução do Tecido de Serviço suporta mais de uma versão da API. Esta é a mais recente versão suportada da API. Se for aprovada uma versão API inferior, 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 suportada mais recente até à versão atual do tempo de execução. Portanto, se a versão Mais recente da API for de 6.0, mas se o tempo de execução for de 6.1, de forma a facilitar a escrita dos clientes, o tempo de execução aceitará a versão 6.1 para essa API. No entanto, o comportamento da API será conforme a versão 6.0 documentada.


EventsHealthStateFilter

Tipo: inteiro
Obrigatório: Não
Padrão:0

Permite filtrar a coleção 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. Só os eventos que combinam com o filtro são devolvidos. Todos os eventos são usados para avaliar o estado de saúde agregado. Se não especificadas, todas as entradas são devolvidas. Os valores do Estado são uma 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 de 6, todos os eventos com o valor do Estado de Saúde de OK (2) e Aviso (4) são devolvidos.

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

DeployedApplicationsHealthStateFilter

Tipo: inteiro
Obrigatório: Não
Padrão:0

Permite a filtragem das aplicações implementadas objetos do estado de saúde devolvidos em resultado de consulta de saúde de aplicação com base no seu 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 as aplicações implantadas que correspondam ao filtro serão devolvidas. Todas as aplicações implementadas são usadas para avaliar o estado de saúde agregado. Se não especificadas, todas as entradas são devolvidas. Os valores do Estado são uma enumeração baseada na bandeira, pelo que o valor pode ser uma combinação destes valores, obtidos utilizando um operador de 'OR' bitwise. Por exemplo, se o valor fornecido for de 6, então o estado de saúde das aplicações implementadas com o valor do Estado de Saúde de OK (2) e Aviso (4) são devolvidos.

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

ServicesHealthStateFilter

Tipo: inteiro
Obrigatório: Não
Padrão:0

Permite a filtragem dos serviços de estado de saúde objetos devolvidos em resultado de consultas de saúde de serviços com base no seu estado de saúde. Os valores possíveis para este parâmetro incluem o valor inteiro de um dos seguintes estados de saúde. Só os serviços que combinam com o filtro são devolvidos. Todos os serviços são utilizados para avaliar o estado de saúde agregado. Se não especificadas, todas as entradas são devolvidas. Os valores do Estado são uma enumeração baseada na bandeira, pelo que o valor pode ser uma combinação destes valores, obtidos utilizando um operador de 'OR' bitwise. Por exemplo, se o valor fornecido for de 6, então o estado de saúde dos serviços com o valor do Estado de Saúde de OK (2) e Aviso (4) será devolvido.

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

ExcludeHealthStatistics

Tipo: boolean
Obrigatório: Não
Padrão:false

Indica se as estatísticas de saúde devem ser devolvidas como parte do resultado da consulta. Falso por defeito. As estatísticas mostram o número de entidades infantis no estado de saúde Ok, Warning e Error.


timeout

Tipo: inteiro (int64)
Obrigatório: Não
Padrão:60
InclusiveMaximum:4294967295
Inclusive Mínimo:1

O tempo de funcionamento do servidor para a execução da operação em segundos. Este prazo especifica a duração do tempo que o cliente está disposto a esperar que a operação solicitada esteja concluída. O valor padrão para este parâmetro é de 60 segundos.


ApplicationHealthPolicy

Tipo: Política de Saúde de Aplicações
Obrigatório: Não

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

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 as informações de saúde do nó solicitadas.
AplicaçõesHealth
Todos os outros códigos de estado A resposta detalhada ao erro.
Erro de Tecido