Partilhar via

Obter a Política de Utilização do Estado de Funcionamento da Partição

  • Artigo

Obtém o estado de funcionamento da partição do Service Fabric especificada através da política de estado de funcionamento especificada.

Obtém as informações de estado de funcionamento da partição especificada. Se a política de estado de funcionamento da aplicação for especificada, a avaliação do estado de funcionamento utiliza-a para obter o estado de funcionamento agregado. Se a política não for especificada, a avaliação do estado de funcionamento utiliza a política de estado de funcionamento da aplicação definida no manifesto da aplicação ou a política de estado de funcionamento predefinida, se não for definida nenhuma política no manifesto. Utilize EventsHealthStateFilter para filtrar a coleção de eventos de estado de funcionamento comunicados na partição com base no estado de funcionamento. Utilize ReplicasHealthStateFilter para filtrar a coleção de objetos ReplicaHealthState na partição. Utilize ApplicationHealthPolicy no corpo POST para substituir as políticas de estado de funcionamento utilizadas para avaliar o estado de funcionamento. Se especificar uma partição que não existe no arquivo de estado de funcionamento, este pedido devolve um erro.

Pedir

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

Parâmetros

Nome Tipo Necessário Localização
partitionId cadeia (uuid) Yes Caminho
api-version string Yes Consulta
EventsHealthStateFilter número inteiro No Consulta
ReplicasHealthStateFilter número inteiro No Consulta
ExcludeHealthStatistics boolean No Consulta
timeout número inteiro (int64) No Consulta
ApplicationHealthPolicy ApplicationHealthPolicy No Corpo

partitionId

Tipo: cadeia (uuid)
Obrigatório: Sim

A identidade da partição.

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 foi 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 da API inferior, 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. Portanto, se a versão mais recente da API for 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á conforme a versão documentada 6.0.

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.

ReplicasHealthStateFilter

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

Permite filtrar a coleção de objetos ReplicaHealthState na partição. O valor pode ser obtido a partir de membros ou operações bit-a-bit em membros do HealthStateFilter. Só serão devolvidas réplicas que correspondam ao filtro. Todas as réplicas serão utilizadas para avaliar o estado de funcionamento agregado. Se não for especificado, todas as entradas serão devolvidas. Os valores de estado são enumeração baseada em sinalizador, pelo que o valor pode ser uma combinação destes valores obtidos 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) serão devolvidos. Os valores possíveis para este parâmetro incluem o valor inteiro de um dos seguintes estados de estado de funcionamento.

  • 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 - filtro 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.

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 que a operação pedida seja concluída. O valor predefinido para este parâmetro é 60 segundos.

ApplicationHealthPolicy

Tipo: ApplicationHealthPolicy
Obrigatório: Não

Descreve as políticas de estado de funcionamento utilizadas para avaliar o estado de funcionamento de uma aplicação ou de um dos respetivos subordinados. Se não estiver presente, a avaliação do estado de funcionamento utiliza a política de estado de funcionamento do manifesto da aplicação ou a política de estado de funcionamento predefinida.

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 sobre a partição especificada.
 PartitionHealth
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError