Share via

Obter informações do aplicativo

  • Artigo

Obtém informações sobre um aplicativo do Service Fabric.

Retorna as informações sobre o aplicativo que foi criado, ou que está sendo criado no cluster do Service Fabric, e cujo nome corresponde àquele especificado como o parâmetro. A resposta inclui o nome, o tipo, o status, os parâmetros e outros detalhes sobre o aplicativo.

Solicitação

Método URI da solicitação
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Parâmetros

Nome Type Obrigatório Location
applicationId string Sim Caminho
api-version string Sim Consulta
ExcludeApplicationParameters booleano Não Consulta
timeout inteiro (int64) Não Consulta

applicationId

Tipo: string
Obrigatório: sim

A identidade do aplicativo. Normalmente, este é o nome completo do aplicativo sem o esquema de URI "fabric:". A partir da versão 6.0, nomes hierárquicos são delimitados pelo caractere "~". Por exemplo, se o nome do aplicativo for "fabric:/meuaplicativo/aplicativo1", a identidade do aplicativo será "meuaplicativo~aplicativo1" na versão 6.0 e superiores, e "meuaplicativo/aplicativo1" nas versões anteriores.

api-version

Tipo: string
Obrigatório: sim
Padrão: 6.0

A versão da API. Esse parâmetro é necessário e seu valor deve ser '6.0'.

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.

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.

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) Informações sobre o aplicativo.
 ApplicationInfo
204 (NoContent) Uma resposta vazia será retornada se a applicationId especificada não for encontrada no cluster.
Todos os outros códigos de status A resposta de erro detalhada.
 FabricError

Exemplos

Obter um aplicativo específico por ID do aplicativo

Este exemplo mostra como obter informações sobre um aplicativo usando seu identificador. Se o aplicativo for encontrado, as informações sobre ele serão retornadas com 200 status código. Se o aplicativo não for encontrado, o conteúdo vazio será retornado com 204 status código.

Solicitação

GET http://localhost:19080/Applications/samples~CalculatorApp?api-version=6.0

Resposta 200

Corpo
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0",
  "Status": "Ready",
  "Parameters": [
    {
      "Key": "CalculatorAppParameter1",
      "Value": "314"
    },
    {
      "Key": "CalculatorAppParameter2",
      "Value": "271"
    }
  ],
  "HealthState": "Ok",
  "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
}

Resposta 204

Corpo

O corpo da resposta está vazio.