Obter Integridade da Partição

Artigo
07/19/2023

Obtém a integridade da partição do Service Fabric especificado.

Use EventsHealthStateFilter para filtrar o conjunto de eventos de integridade relatados no serviço de acordo com o estado de integridade. Utilize ReplicasHealthStateFilter para filtrar a coleção dos objetos ReplicaHealthState na partição. Se você especificar um serviço que não existe no repositório de integridade, essa solicitação retornará um erro.

Solicitação

Método	URI da solicitação
GET	`/Partitions/{partitionId}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&ReplicasHealthStateFilter={ReplicasHealthStateFilter}&ExcludeHealthStatistics={ExcludeHealthStatistics}&timeout={timeout}`

Parâmetros

Nome	Type	Obrigatório	Location
`partitionId`	string (uuid)	Sim	Caminho
`api-version`	string	Sim	Consulta
`EventsHealthStateFilter`	inteiro	Não	Consulta
`ReplicasHealthStateFilter`	inteiro	Não	Consulta
`ExcludeHealthStatistics`	booleano	Não	Consulta
`timeout`	inteiro (int64)	Não	Consulta

`partitionId`

Tipo: cadeia de caracteres (uuid)
Obrigatório: sim

A identidade da partição.

`api-version`

Tipo: string
Obrigatório: sim
Padrão: 6.0

A versão da API. Esse parâmetro é necessário e seu valor deve 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 dá suporte a mais de uma versão da API. Esta é a versão mais recente com suporte da API. Se uma versão inferior da API for passada, a resposta retornada poderá ser diferente daquela documentada nesta especificação.

Além disso, o runtime aceita qualquer versão que seja maior do que a versão mais recente com suporte até a 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 gravação 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 documentada 6.0.

`EventsHealthStateFilter`

Tipo: inteiro
Obrigatório: não
Padrão: 0

Permite filtrar a coleção de objetos HealthEvent retornados com base no estado de integridade. Os valores possíveis para esse parâmetro incluem o valor de inteiro de um dos seguintes estados de integridade. Somente os eventos que correspondem ao filtro são retornados. Todos os eventos são usados para avaliar o estado de integridade agregado. Se não for especificado, retorna todas as entradas. Os valores de estado são enumerações baseadas no sinalizador. Assim, o valor pode ser uma combinação desses valores obtidos, usando o operador “OR” bit a bit. Por exemplo, se o valor fornecido for 6, serão retornados todos os eventos com o valor de HealthState de OK (2) e de Aviso (4).

Padrão – valor padrão. Corresponde a qualquer HealthState. O valor é zero.
Nenhum – filtro que não corresponde a nenhum valor de HealthState. Usado para não retornar qualquer resultado em um determinado conjunto de estados. O valor é 1.
Ok - Filtro que corresponde à entrada com o valor de HealthState Ok. O valor é 2.
Aviso – filtro que corresponde à entrada com o valor de HealthState Aviso. O valor é 4.
Erro – filtro que corresponde à entrada com o valor de HealthState Error. O valor é 8.
Todos – Filtro que corresponde à entrada com qualquer valor HealthState. O valor é 65535.

`ReplicasHealthStateFilter`

Tipo: inteiro
Obrigatório: não
Padrão: 0

Permite a filtragem da coleção de objetos ReplicaHealthState na partição. O valor pode ser obtido de membros ou operações bit a bit em membros de HealthStateFilter. Somente as réplicas que correspondem ao filtro retornam. Todas as réplicas serão usadas para avaliar o estado de integridade agregado. Se não especificado, todas as entradas serão retornadas. Os valores de estado são enumerações baseadas no sinalizador. Assim, o valor pode ser uma combinação desses valores obtidos, usando o operador 'OR' bit a bit. Por exemplo, se o valor fornecido for 6, serão retornados todos os eventos com o valor OK (2) e Warning (4) de HealthState. Os valores possíveis para esse parâmetro incluem o valor de inteiro de um dos seguintes estados de integridade.

Padrão – valor padrão. Corresponde a qualquer HealthState. O valor é zero.
Nenhum – filtro que não corresponde a nenhum valor de HealthState. Usado para não retornar qualquer resultado em um determinado conjunto de estados. O valor é 1.
Ok - Filtro que corresponde à entrada com o valor de HealthState Ok. O valor é 2.
Aviso – filtro que corresponde à entrada com o valor de HealthState Aviso. O valor é 4.
Erro – filtro que corresponde à entrada com o valor de HealthState Error. O valor é 8.
Todos – Filtro que corresponde à entrada com qualquer valor HealthState. O valor é 65535.

`ExcludeHealthStatistics`

Tipo: booliano
Obrigatório: não
Padrão: false

Indica se as estatísticas de integridade devem ser retornadas como parte do resultado da consulta. Falso por padrão. As estatísticas mostram o número de entidades filhas nos estados de integridade Ok, Warning e Error.

`timeout`

Tipo: inteiro (int64)
Obrigatório: não
Padrão: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Tempo limite do servidor para executar a operação em segundos. Especifica o tempo que o cliente está disposto a esperar para que operação solicitada seja concluída. O valor padrão desse parâmetro é 60 segundos.

Respostas

Código de status HTTP	Descrição	Esquema de Resposta
200 (OK)	Uma operação bem-sucedida retornará 200 status código e as informações de integridade sobre a partição especificada.	PartitionHealth
Todos os outros códigos de status	A resposta de erro detalhada.	FabricError

Compartilhar via