Obter lista de informações do aplicativo implantado

Obtém a lista de aplicativos implantados em um nó do Service Fabric.

Obtém a lista de aplicativos implantados em um nó do Service Fabric. Os resultados não incluem informações sobre aplicativos de sistema implantados, a menos que explicitamente consultados por ID. 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?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}

Parâmetros

Nome	Type	Obrigatório	Location
nodeName	string	Sim	Caminho
api-version	string	Sim	Consulta
timeout	inteiro (int64)	Não	Consulta
IncludeHealthState	booleano	Não	Consulta
ContinuationToken	string	Não	Consulta
MaxResults	inteiro (int64)	Não	Consulta

---

nodeName

Tipo: string
Obrigatório: sim

O nome do nó.

---

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 é baseada na versão de runtime na qual a API foi introduzida ou 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 nessa especificação.

Além disso, o runtime aceita qualquer versão 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.

---

ContinuationToken

Tipo: string
Obrigatório: não

O parâmetro do token de continuação é usado para obter o próximo conjunto de resultados. Um token de continuação com um valor não vazio será incluso na resposta da API quando os resultados do sistema não couberem em uma única resposta. Quando esse valor for passado para a próxima chamada de API, a API retornará o próximo conjunto de resultados. Se não houver mais resultados, o token de continuação não conterá um valor. O valor desse parâmetro não deve ser codificado em URL.

---

MaxResults

Tipo: inteiro (int64)
Obrigatório: não
Padrão: 0
InclusiveMinimum: 0

O número máximo de resultados a serem retornados como parte das consultas paginadas. Esse parâmetro define o limite superior no número de resultados retornados. Os resultados retornados podem ser inferiores aos resultados máximos especificados se não couberem na mensagem, de acordo com as restrições de tamanho máximo de mensagem definidas na configuração. Se esse parâmetro for zero, ou não for especificado, a consulta paginada incluirá o máximo de resultados possível na mensagem de retorno.

Respostas

Código de status HTTP	Descrição	Esquema de Resposta
200 (OK)	Uma operação bem-sucedida retornará 200 status código e a lista de informações de aplicativo implantadas.	PagedDeployedApplicationInfoList
Todos os outros códigos status	A resposta de erro detalhada.	FabricError

Exemplos

Limitar os resultados máximos

Este exemplo mostra como especificar o número de aplicativos retornados pela consulta ao obter informações sobre aplicativos implantados em um nó específico. O número de resultados em uma página é limitado ao máximo de 2 usando o parâmetro MaxResult. O estado de integridade não é solicitado neste exemplo, portanto, o estado de integridade retornado será Desconhecido.

Solicitação

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&MaxResults=2

Resposta 200

Corpo

{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Unknown"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Página usando token de continuação

Este exemplo demonstra a funcionalidade de paginação disponível ao obter informações sobre aplicativos implantados em um nó específico. Este exemplo usa o parâmetro ContinuationToken. O valor desse parâmetro é fornecido da consulta anterior; nesse caso, o exemplo mostrado acima. A resposta contém os resultados restantes e um ContinuationToken vazio. O ContinuationToken vazio indica que resultados adicionais não estão disponíveis.

Solicitação

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1

Resposta 200

Corpo

{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Incluir o estado de integridade no resultado

Este exemplo mostra como incluir o estado de integridade de cada aplicativo implantado ao obter informações sobre aplicativos implantados em um nó específico.

Solicitação

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

Resposta 200

Corpo

{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Ok"
    }
  ]
}