Obter Informações da Aplicação

  • Artigo

Obtém informações sobre uma aplicação do Service Fabric.

Devolve as informações sobre a aplicação que foi criada ou no processo de criação no cluster do Service Fabric e cujo nome corresponde ao especificado como o parâmetro . A resposta inclui o nome, o tipo, o estado, os parâmetros e outros detalhes sobre a aplicação.

Pedir

Método URI do pedido
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Parâmetros

Nome Tipo Necessário Localização
applicationId string Yes Caminho
api-version string Yes Consulta
ExcludeApplicationParameters boolean No Consulta
timeout número inteiro (int64) No Consulta

applicationId

Tipo: cadeia
Obrigatório: Sim

A identidade da aplicação. Normalmente, este é o nome completo da aplicação sem o esquema de URI "fabric:". A partir da versão 6.0, os nomes hierárquicos são delimitados com o caráter "~". Por exemplo, se o nome da aplicação for "fabric:/myapp/app1", a identidade da aplicação será "myapp~app1" na versão 6.0+ e "myapp/app1" em versões anteriores.

api-version

Tipo: cadeia
Obrigatório: Sim
Predefinição: 6.0

A versão da API. Este parâmetro é obrigatório e o respetivo valor tem de 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 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.

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.

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) Informações sobre a aplicação.
 ApplicationInfo
204 (NoContent) É devolvida uma resposta vazia se o applicationId especificado não for encontrado no cluster.
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError

Exemplos

Obter uma aplicação específica por ID da aplicação

Este exemplo mostra como obter informações sobre uma aplicação com o seu identificador. Se a aplicação for encontrada, as informações sobre a mesma são devolvidas com o código de estado 200. Se a aplicação não for encontrada, o conteúdo vazio é devolvido com o código de estado 204.

Pedir

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.