Estado de Funcionamento da Partição de Relatórios

Artigo
08/05/2023

Envia um relatório de estado de funcionamento na partição do Service Fabric.

Comunica o estado de funcionamento da partição especificada do Service Fabric. O relatório tem de conter as informações sobre a origem do relatório de estado de funcionamento e da propriedade na qual é comunicado. O relatório é enviado para uma Partição de gateway do Service Fabric, que é reencaminhada 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 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, execute GetPartitionHealth e verifique se o relatório é apresentado na secção HealthEvents.

Pedir

Método	URI do pedido
POST	`/Partitions/{partitionId}/$/ReportHealth?api-version=6.0&Immediate={Immediate}&timeout={timeout}`

Parâmetros

Nome	Tipo	Necessário	Localização
`partitionId`	cadeia (uuid)	Yes	Caminho
`api-version`	string	Yes	Consulta
`Immediate`	boolean	No	Consulta
`timeout`	número inteiro (int64)	No	Consulta
`HealthInformation`	HealthInformation	Yes	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.

`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 DE HTTP para o arquivo de estado de funcionamento, independentemente das definições de 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. Consoante a temporização e 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 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 pela conclusão da operação pedida. 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

Partilhar via