Obter Lista de Informações de Serviço
Obtém as informações sobre todos os serviços pertencentes à aplicação especificados pelo ID da aplicação.
Devolve as informações sobre todos os serviços pertencentes à aplicação especificada pelo ID da aplicação.
Pedir
| Método | URI do pedido |
|---|---|
| GET | /Applications/{applicationId}/$/GetServices?ServiceTypeName={ServiceTypeName}&api-version=6.0&ContinuationToken={ContinuationToken}&timeout={timeout} |
Parâmetros
| Nome | Tipo | Necessário | Localização |
|---|---|---|---|
applicationId |
string | Yes | Caminho |
ServiceTypeName |
cadeia (de carateres) | No | Consulta |
api-version |
string | Yes | Consulta |
ContinuationToken |
cadeia (de carateres) | 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 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" em 6.0+ e "myapp/app1" em versões anteriores.
ServiceTypeName
Tipo: cadeia
Obrigatório: Não
O nome do tipo de serviço utilizado para filtrar os serviços para consultar.
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 foi 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 da API inferior, 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. Portanto, se a versão mais recente da API for 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á conforme a versão documentada 6.0.
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.
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 pela conclusão da operação pedida. O valor predefinido para este parâmetro é 60 segundos.
Respostas
| Código de Estado HTTP | Description | Esquema de Resposta |
|---|---|---|
| 200 (OK) | Lista de serviços no cluster para a aplicação especificada. |
PagedServiceInfoList |
| Todos os outros códigos de estado | A resposta detalhada ao erro. |
FabricError |