Obter Estado de Funcionamento do Nó com a Política
Obtém o estado de funcionamento de um nó do Service Fabric com a política de estado de funcionamento especificada.
Obtém o estado de funcionamento de um nó do Service Fabric. Utilize EventsHealthStateFilter para filtrar a coleção de eventos de estado de funcionamento comunicados no nó com base no estado de funcionamento. Utilize ClusterHealthPolicy no corpo POST para substituir as políticas de estado de funcionamento utilizadas para avaliar o estado de funcionamento. Se o nó que especificar por nome não existir no arquivo de estado de funcionamento, será devolvido um erro.
Pedir
| Método | URI do pedido |
|---|---|
| POST | /Nodes/{nodeName}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout} |
Parâmetros
| Nome | Tipo | Necessário | Localização |
|---|---|---|---|
nodeName |
string | Yes | Caminho |
api-version |
string | Yes | Consulta |
EventsHealthStateFilter |
número inteiro | No | Consulta |
timeout |
número inteiro (int64) | No | Consulta |
ClusterHealthPolicy |
ClusterHealthPolicy | No | Corpo |
nodeName
Tipo: cadeia
Obrigatório: Sim
O nome do nó.
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.
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 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 uma enumeração baseada em sinalizadores, pelo que o valor pode ser uma combinação destes valores, obtida com o operador bit-a-bit "OR". 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 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.
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.
ClusterHealthPolicy
Tipo: ClusterHealthPolicy
Obrigatório: Não
Descreve as políticas de estado de funcionamento utilizadas para avaliar o estado de funcionamento de um cluster ou nó. Se não estiver presente, a avaliação do estado de funcionamento utiliza a política de estado de funcionamento do manifesto do cluster 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 do nó pedidas. |
NodeHealth |
| Todos os outros códigos de estado | A resposta detalhada ao erro. |
FabricError |