Partilhar via

Obter Informações da Aplicação Implementada

  • Artigo

Obtém as informações sobre uma aplicação implementada num nó do Service Fabric.

Esta consulta devolve informações da aplicação do sistema se o ID da aplicação fornecido for para a aplicação de sistema. Os resultados abrangem aplicações implementadas em estados ativos, de ativação e de transferência. Esta consulta requer que o nome do nó corresponda a um nó no cluster. A consulta falha se o nome do nó fornecido não apontar para nós ativos do Service Fabric no cluster.

Pedir

Método URI do pedido
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}

Parâmetros

Nome Tipo Necessário Localização
nodeName string Yes Caminho
applicationId string Yes Caminho
api-version string Yes Consulta
timeout número inteiro (int64) No Consulta
IncludeHealthState boolean 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 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" em 6.0+ e "myapp/app1" em versões anteriores.

api-version

Tipo: cadeia
Obrigatório: Sim
Predefinição: 6.1

A versão da API. Este parâmetro é obrigatório e o respetivo valor tem de 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 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.

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.

IncludeHealthState

Tipo: booleano
Obrigatório: Não
Predefinição: false

Inclua o estado de funcionamento de uma entidade. Se este parâmetro for falso ou não for especificado, o estado de funcionamento devolvido é "Desconhecido". Quando definida como verdadeira, a consulta fica paralela ao nó e ao serviço do sistema de estado de funcionamento antes de os resultados serem intercalados. Como resultado, a consulta é mais cara e pode demorar mais tempo.

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 sobre a aplicação implementada.
 DeployedApplicationInfo
204 (NoContent) É devolvida uma resposta vazia se a aplicação especificada não for implementada no nó.
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError

Exemplos

Obter uma aplicação implementada específica por ID da aplicação e incluir o estado de funcionamento no resultado

Este exemplo mostra como obter informações sobre uma aplicação implementada num nó especificado com um identificador de aplicação. Se a aplicação for encontrada, as informações são devolvidas com o código de estado 200. É devolvida uma resposta vazia com o código de estado 204, se a aplicação especificada não for implementada no nó.

Pedir

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.