Obter o Estado de Funcionamento da Aplicação Implementado
Obtém as informações sobre o estado de funcionamento de uma aplicação implementada num nó do Service Fabric.
Obtém as informações sobre o estado de funcionamento de uma aplicação implementada num nó do Service Fabric. Utilize EventsHealthStateFilter para filtrar opcionalmente a coleção de objetos HealthEvent comunicados na aplicação implementada com base no estado de funcionamento. Utilize DeployedServicePackagesHealthStateFilter para filtrar opcionalmente as crianças DeployedServicePackageHealth com base no estado de funcionamento.
Pedir
Método | URI do pedido |
---|---|
GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&DeployedServicePackagesHealthStateFilter={DeployedServicePackagesHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout} |
Parâmetros
Nome | Tipo | Necessário | Localização |
---|---|---|---|
nodeName |
string | Yes | Caminho |
applicationId |
string | Yes | Caminho |
api-version |
string | Yes | Consulta |
EventsHealthStateFilter |
número inteiro | No | Consulta |
DeployedServicePackagesHealthStateFilter |
número inteiro | No | Consulta |
ExcludeHealthStatistics |
boolean | No | Consulta |
timeout |
número inteiro (int64) | No | Consulta |
nodeName
Tipo: cadeia
Obrigatório: Sim
O nome do nó.
applicationId
Tipo: cadeia
Obrigatório: Sim
A identidade da aplicação. Normalmente, este é o nome completo da aplicação sem o esquema URI "fabric:".
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 "fabric:/myapp/app1", a identidade da aplicação será "myapp~app1" em 6.0+ e "myapp/app1" em versões anteriores.
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.
DeployedServicePackagesHealthStateFilter
Tipo: número inteiro
Obrigatório: Não
Predefinição: 0
Permite a filtragem dos objetos de estado de funcionamento do pacote de serviço implementados devolvidos no resultado da consulta de estado de funcionamento da aplicação implementada com base no respetivo 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 pacotes de serviço implementados que correspondam ao filtro. Todos os pacotes de serviço implementados são utilizados para avaliar o estado de funcionamento agregado da aplicação implementada.
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, serão devolvidos o estado de funcionamento dos pacotes de serviço com o valor HealthState de OK (2) e Aviso (4).
- 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.
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 da aplicação implementada. |
DeployedApplicationHealth |
Todos os outros códigos de estado | A resposta detalhada ao erro. |
FabricError |