Obter informações do aplicativo implantado

Obtém as informações sobre um aplicativo implantado em um nó do Service Fabric.

Essa consulta retorna informações do aplicativo do sistema se a ID do aplicativo fornecida é para o aplicativo do sistema. Os resultados abrangem aplicativos implantados nos estados ativo, ativando e baixando. Essa consulta requer que o nome do nó corresponda a um nó no cluster. A consulta falhará se o nome do nó fornecido não apontar para qualquer nó do Service Fabric ativo no cluster.

Solicitação

Método URI da solicitação
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}

Parâmetros

Nome Type Obrigatório Location
nodeName string Sim Caminho
applicationId string Sim Caminho
api-version string Sim Consulta
timeout inteiro (int64) Não Consulta
IncludeHealthState booleano 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.

api-version

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

A versão da API. Esse parâmetro é necessário e seu valor deve ser '6.1'.

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.

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.

IncludeHealthState

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

Inclua o estado de integridade de uma entidade. Se esse parâmetro for definido como false ou não especificado, o estado de integridade retornado será "Desconhecido". Quando definido como true, a consulta será paralela ao nó e ao serviço do sistema de integridade, antes que os resultados sejam mesclados. Consequentemente, a consulta é mais onerosa e pode levar mais tempo.

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 sobre o aplicativo implantado.
 DeployedApplicationInfo
204 (NoContent) Uma resposta vazia será retornada se o aplicativo especificado não for implantado no nó.
Todos os outros códigos de status A resposta de erro detalhada.
 FabricError

Exemplos

Obter um aplicativo implantado específico por ID do aplicativo e incluir o estado de integridade no resultado

Este exemplo mostra como obter informações sobre um aplicativo implantado em um nó especificado usando um identificador de aplicativo. Se o aplicativo for encontrado, suas informações serão retornadas com 200 status código. Uma resposta vazia com status código 204 será retornada, se o aplicativo especificado não for implantado no nó.

Solicitação

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True

Resposta 200

Corpo
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0.0",
  "Status": "Active",
  "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
  "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
  "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
  "HealthState": "Ok"
}

Resposta 204

Corpo

O corpo da resposta está vazio.

  • Last updated on