Partilhar via

Report Deployed Application Health

  • Artigo

Envia um relatório de estado de funcionamento sobre a aplicação do Service Fabric implementada num nó do Service Fabric.

Comunica o estado de funcionamento da aplicação implementada num nó do Service Fabric. O relatório tem de conter as informações sobre a origem do relatório de estado de funcionamento e a propriedade na qual é comunicado. O relatório é enviado para um Serviço de gateway do Service Fabric, que é reencaminhado para o arquivo de estado de funcionamento. O relatório pode ser aceite pelo gateway, mas rejeitado pelo arquivo de estado de funcionamento após uma validação adicional. Por exemplo, o arquivo de estado de funcionamento pode rejeitar o relatório devido a um parâmetro inválido, como um número de sequência obsoleto. Para ver se o relatório foi aplicado no arquivo de estado de funcionamento, obtenha o estado de funcionamento da aplicação implementado e verifique se o relatório aparece na secção HealthEvents.

Pedir

Método URI do pedido
POST /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth?api-version=6.0&Immediate={Immediate}&timeout={timeout}

Parâmetros

Nome Tipo Necessário Localização
nodeName string Yes Caminho
applicationId string Yes Caminho
api-version string Yes Consulta
Immediate boolean No Consulta
timeout número inteiro (int64) No Consulta
HealthInformation HealthInformation Yes Corpo

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 de 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" na versão 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 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.

Immediate

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

Um sinalizador que indica se o relatório deve ser enviado imediatamente. É enviado um relatório de estado de funcionamento para uma Aplicação de gateway do Service Fabric, que é reencaminhada para o arquivo de estado de funcionamento. Se Imediato estiver definido como verdadeiro, o relatório é enviado imediatamente do Gateway HTTP para o arquivo de estado de funcionamento, independentemente das definições do cliente de recursos de infraestrutura que a Aplicação de Gateway de HTTP está a utilizar. Isto é útil para relatórios críticos que devem ser enviados o mais rapidamente possível. Dependendo da temporização e de outras condições, o envio do relatório pode continuar a falhar, por exemplo, se o Gateway de HTTP estiver fechado ou a mensagem não chegar ao Gateway. Se Imediato estiver definido como falso, o relatório é enviado com base nas definições do cliente de estado de funcionamento do Gateway de HTTP. Por conseguinte, será em lote de acordo com a configuração HealthReportSendInterval. Esta é a definição recomendada porque permite ao cliente de estado de funcionamento otimizar as mensagens de relatórios de estado de funcionamento para o arquivo de estado de funcionamento, bem como o processamento de relatórios de estado de funcionamento. Por predefinição, os relatórios não são enviados imediatamente.

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.

HealthInformation

Tipo: HealthInformation
Obrigatório: Sim

Descreve as informações de estado de funcionamento do relatório de estado de funcionamento. Estas informações têm de estar presentes em todos os relatórios de estado de funcionamento enviados ao gestor de estado de funcionamento.

Respostas

Código de Estado HTTP Description Esquema de Resposta
200 (OK) Uma operação bem-sucedida devolverá o código de estado 200.
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError