Obter Lista de Informações do Tipo de Aplicação por Nome
Obtém a lista de tipos de aplicações no cluster do Service Fabric que correspondem exatamente ao nome especificado.
Devolve as informações sobre os tipos de aplicações que são aprovisionados ou no processo de aprovisionamento no cluster do Service Fabric. Estes resultados são de tipos de aplicações cujo nome corresponde exatamente ao especificado como o parâmetro e que estão em conformidade com os parâmetros de consulta especificados. São devolvidas todas as versões do tipo de aplicação que correspondem ao nome do tipo de aplicação, sendo que cada versão é devolvida como um tipo de aplicação. A resposta inclui o nome, a versão, o estado e outros detalhes sobre o tipo de aplicação. Esta é uma consulta paginada, o que significa que, se nem todos os tipos de aplicações 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. Por exemplo, se existirem 10 tipos de aplicação, mas uma página se ajustar apenas aos três primeiros tipos de aplicação ou se o máximo de resultados estiver definido como 3, serão devolvidos três. Para aceder ao resto dos resultados, obtenha as páginas subsequentes com o token de continuação devolvido na consulta seguinte. Um token de continuação vazio é devolvido se não existirem páginas subsequentes.
Pedir
| Método | URI do pedido |
|---|---|
| GET | /ApplicationTypes/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout} |
Parâmetros
| Nome | Tipo | Necessário | Localização |
|---|---|---|---|
applicationTypeName |
string | Yes | Caminho |
api-version |
string | Yes | Consulta |
ApplicationTypeVersion |
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 |
applicationTypeName
Tipo: cadeia
Obrigatório: Sim
O nome do tipo de aplicação.
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.
ApplicationTypeVersion
Tipo: cadeia
Obrigatório: Não
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 tipos de aplicações no cluster. |
PagedApplicationTypeInfoList |
| Todos os outros códigos de estado | A resposta detalhada ao erro. |
FabricError |