Partilhar via

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

  • Artigo

Obtém a lista de aplicações criadas no cluster do Service Fabric que correspondem aos filtros especificados.

Obtém as informações sobre as aplicações que foram criadas ou no processo de criação no cluster do Service Fabric e correspondem aos filtros especificados. A resposta inclui o nome, o tipo, o estado, os parâmetros e outros detalhes sobre a aplicação. Se as aplicações não caberem numa página, é devolvida uma página de resultados, bem como um token de continuação, que pode ser utilizado para obter a página seguinte. Os filtros ApplicationTypeName e ApplicationDefinitionKindFilter não podem ser especificados ao mesmo tempo.

Pedir

Método URI do pedido
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parâmetros

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

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 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 inferior da API, 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. Por isso, se a versão mais recente da API for a 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á de acordo com a versão 6.0 documentada.

ApplicationDefinitionKindFilter

Tipo: número inteiro
Obrigatório: Não
Predefinição: 0

Utilizado para filtrar em ApplicationDefinitionKind, que é o mecanismo utilizado para definir uma aplicação do Service Fabric.

  • Predefinição – valor predefinido, que executa a mesma função que selecionar "Todos". O valor é 0.
  • All - filtro que corresponde à entrada com qualquer valor ApplicationDefinitionKind. O valor é 65535.
  • ServiceFabricApplicationDescription – filtro que corresponde à entrada com o valor ApplicationDefinitionKind ServiceFabricApplicationDescription. O valor é 1.
  • Compor – filtro que corresponde à entrada com o valor ApplicationDefinitionKind Compose. O valor é 2.

ApplicationTypeName

Tipo: cadeia
Obrigatório: Não

O nome do tipo de aplicação utilizado para filtrar as aplicações para consulta. Este valor não deve conter a versão do tipo de aplicação.

ExcludeApplicationParameters

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

O sinalizador que especifica se os parâmetros da aplicação serão excluídos do resultado.

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 caberem na mensagem de acordo com as restrições de tamanho máximo de mensagens 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 cabem na mensagem de retorno.

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 que a operação pedida seja concluída. O valor predefinido para este parâmetro é 60 segundos.

Respostas

Código de Estado HTTP Description Esquema de Resposta
200 (OK) Lista de aplicações criadas no cluster.
 PagedApplicationInfoList
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError

Exemplos

Limitar os resultados máximos

Este exemplo mostra como obter informações sobre aplicações no cluster. O número de resultados numa página está limitado ao máximo de dois com o parâmetro MaxResult.

Pedir

GET http://localhost:19080/Applications?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",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}

Página com o token de continuação

Este exemplo mostra como analisar as informações sobre aplicações no cluster com o parâmetro ContinuationToken. O valor deste parâmetro é fornecido a partir da consulta anterior, neste caso, o exemplo mostrado acima. A resposta contém o resultado restante e um ContinuationToken vazio. O ContinuationToken vazio indica que não estão disponíveis resultados adicionais.

Pedir

GET http://localhost:19080/Applications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1&MaxResults=2

Resposta 200

Corpo
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0",
      "Status": "Ready",
      "Parameters": [],
      "HealthState": "Ok",
      "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
    }
  ]
}