Partilhar via

Obter o Estado de Funcionamento do Pacote de Serviço Implementado

  • Artigo

Obtém as informações sobre o estado de funcionamento de um pacote de serviço para uma aplicação específica implementada para um nó e aplicação do Service Fabric.

Obtém as informações sobre o estado de funcionamento de um pacote de serviço para uma aplicação específica implementada num nó do Service Fabric. Utilize EventsHealthStateFilter para filtrar opcionalmente a coleção de objetos HealthEvent comunicados no pacote de serviço implementado com base no estado de funcionamento.

Pedir

Método URI do pedido
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout}

Parâmetros

Nome Tipo Necessário Localização
nodeName string Yes Caminho
applicationId string Yes Caminho
servicePackageName string Yes Caminho
api-version string Yes Consulta
EventsHealthStateFilter número inteiro 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 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.

servicePackageName

Tipo: cadeia
Obrigatório: Sim

O nome do pacote de serviç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 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.

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 pacote de serviço implementado para um nó e aplicação específicos.
 DeployedServicePackageHealth
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError