Obter Lista de Informações da Aplicação Implementada

Obtém a lista de aplicações implementadas num nó do Service Fabric.

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

Parâmetros

Nome	Tipo	Necessário	Localização
nodeName	string	Yes	Caminho
api-version	string	Yes	Consulta
timeout	número inteiro (int64)	No	Consulta
IncludeHealthState	boolean	No	Consulta
ContinuationToken	cadeia (de carateres)	No	Consulta
MaxResults	número inteiro (int64)	No	Consulta

---

nodeName

Tipo: cadeia
Obrigatório: Sim

O nome do nó.

---

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.

---

ContinuationToken

Tipo: cadeia
Obrigatório: Não

O parâmetro do token de continuação é utilizado para obter o próximo conjunto de resultados. Um token de continuação com um valor não vazio é incluído na resposta da API quando os resultados do sistema não cabem numa única resposta. Quando este valor é transmitido para a próxima chamada à API, a API devolve o próximo conjunto de resultados. Se não existirem mais resultados, o token de continuação não contém um valor. O valor deste parâmetro não deve ser codificado por URL.

---

MaxResults

Tipo: número inteiro (int64)
Obrigatório: Não
Predefinição: 0
InclusiveMinimum: 0

O número máximo de resultados a devolver como parte das consultas paginadas. Este parâmetro define o limite superior no número de resultados devolvidos. Os resultados devolvidos podem ser inferiores aos resultados máximos especificados se não se ajustarem à mensagem de acordo com as restrições de tamanho máximo da mensagem definidas na configuração. Se este parâmetro for zero ou não for especificado, a consulta paginada inclui o maior número possível de resultados que se enquadram na mensagem de retorno.

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 a lista de informações da aplicação implementadas.	PagedDeployedApplicationInfoList
Todos os outros códigos de estado	A resposta detalhada ao erro.	FabricError

Exemplos

Limitar os resultados máximos

Este exemplo mostra como especificar o número de aplicações devolvidas pela consulta ao obter informações sobre aplicações implementadas num nó específico. O número de resultados numa página está limitado ao máximo de 2 com o parâmetro MaxResult. O estado de funcionamento não é pedido neste exemplo, pelo que o estado de funcionamento devolvido será Desconhecido.

Pedir

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 com o token de continuação

Este exemplo demonstra a funcionalidade de paginação disponível ao obter informações sobre aplicações implementadas num nó específico. Este exemplo utiliza o parâmetro ContinuationToken. O valor deste parâmetro é fornecido a partir da consulta anterior; neste caso, o exemplo apresentado acima. A resposta contém os resultados restantes e um ContinuationToken vazio. O ContinuationToken vazio indica que não estão disponíveis resultados adicionais.

Pedir

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 estado de funcionamento no resultado

Este exemplo mostra como incluir o estado de funcionamento de cada aplicação implementada ao obter informações sobre aplicações implementadas num nó específico.

Pedir

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"
    }
  ]
}