Obter Integridade do Pacote de Serviço Implantado
Obtém as informações sobre a integridade de um pacote de serviço para um aplicativo específico implantado em um nó e em um aplicativo do Service Fabric.
Obtém as informações sobre a integridade do pacote de serviço para um aplicativo específico implantado em um nó do Microsoft Azure Service Fabric. Use EventsHealthStateFilter para filtrar, opcionalmente, a coleção de objetos HealthEvent relatado no pacote de serviço implantado com base no estado de integridade.
Solicitação
| Método | URI da solicitação |
|---|---|
| GET | /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth?api-version=6.0&EventsHealthStateFilter={EventsHealthStateFilter}&timeout={timeout} |
Parâmetros
| Nome | Type | Obrigatório | Location |
|---|---|---|---|
nodeName |
string | Sim | Caminho |
applicationId |
string | Sim | Caminho |
servicePackageName |
string | Sim | Caminho |
api-version |
string | Sim | Consulta |
EventsHealthStateFilter |
inteiro | Não | Consulta |
timeout |
inteiro (int64) | Não | Consulta |
nodeName
Tipo: string
Obrigatório: sim
O nome do nó.
applicationId
Tipo: string
Obrigatório: sim
A identidade do aplicativo. Normalmente, este é o nome completo do aplicativo sem o esquema de URI "fabric:".
A partir da versão 6.0, nomes hierárquicos são delimitados pelo caractere "~".
Por exemplo, se o nome do aplicativo for "fabric:/meuaplicativo/aplicativo1", a identidade do aplicativo será "meuaplicativo~aplicativo1" na versão 6.0 e superiores, e "meuaplicativo/aplicativo1" nas versões anteriores.
servicePackageName
Tipo: string
Obrigatório: sim
O nome do pacote de serviç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.
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 do pacote de serviço implantado para um nó e aplicativo específicos. |
DeployedServicePackageHealth |
| Todos os outros códigos de status | A resposta de erro detalhada. |
FabricError |