Compartilhar via

Obter lista de informações do aplicativo

  • Artigo

Obtém a lista de aplicativos criados no cluster do Service Fabric que correspondem aos filtros especificados.

Obtém as informações sobre os aplicativos que foram criados, ou que estão sendo criados no cluster do Service Fabric, e que correspondem aos filtros especificados. A resposta inclui o nome, o tipo, o status, os parâmetros e outros detalhes sobre o aplicativo. Se os aplicativos não couberem em uma página, uma página de resultados retornará junto com um token de continuação, que poderá ser usado para acessar a próxima página. Os filtros ApplicationTypeName e ApplicationDefinitionKindFilter não podem ser especificados ao mesmo tempo.

Solicitação

Método URI da solicitação
GET /Applications?api-version=6.1&ApplicationDefinitionKindFilter={ApplicationDefinitionKindFilter}&ApplicationTypeName={ApplicationTypeName}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parâmetros

Nome Type Obrigatório Location
api-version string Sim Consulta
ApplicationDefinitionKindFilter inteiro Não Consulta
ApplicationTypeName string Não Consulta
ExcludeApplicationParameters booleano Não Consulta
ContinuationToken string Não Consulta
MaxResults inteiro (int64) Não Consulta
timeout inteiro (int64) Não Consulta

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.

ApplicationDefinitionKindFilter

Tipo: inteiro
Obrigatório: não
Padrão: 0

Usado para filtrar ApplicationDefinitionKind, que é o mecanismo usado para definir um aplicativo do Service Fabric.

  • Padrão – valor padrão, que executa a mesma função que selecionar "Todos". O valor é 0.
  • Todos – Filtro que corresponde à entrada com qualquer valor ApplicationDefinitionKind. O valor é 65535.
  • ServiceFabricApplicationDescription - Filtro que corresponde à entrada com o valor ApplicationDefinitionKind ServiceFabricApplicationDescription. O valor é 1.
  • Redigir – Filtro que corresponde à entrada com o valor ApplicationDefinitionKind Compose. O valor é 2.

ApplicationTypeName

Tipo: string
Obrigatório: não

O nome do tipo de aplicativo usado para filtrar os aplicativos para consulta. Esse valor não deve conter a versão do tipo de aplicativo.

ExcludeApplicationParameters

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

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

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.

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.

Respostas

Código de status HTTP Descrição Esquema de Resposta
200 (OK) Lista de aplicativos criados no cluster.
 PagedApplicationInfoList
Todos os outros códigos status A resposta de erro detalhada.
 FabricError

Exemplos

Limitar os resultados máximos

Este exemplo mostra como obter informações sobre aplicativos no cluster. O número de resultados em uma página é limitado ao máximo de dois usando o parâmetro MaxResult.

Solicitação

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

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

Solicitação

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