Obter Lista de Informações do Serviço

Artigo
08/05/2023

Obtém as informações sobre todos os serviços pertencentes ao aplicativo especificado pela ID de aplicativo.

Retorna as informações sobre todos os serviços pertencentes ao aplicativo especificado pela ID de aplicativo.

Solicitação

Método	URI da solicitação
GET	`/Applications/{applicationId}/$/GetServices?ServiceTypeName={ServiceTypeName}&api-version=6.0&ContinuationToken={ContinuationToken}&timeout={timeout}`

Parâmetros

Nome	Type	Obrigatório	Location
`applicationId`	string	Sim	Caminho
`ServiceTypeName`	string	Não	Consulta
`api-version`	string	Sim	Consulta
`ContinuationToken`	string	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.

`ServiceTypeName`

Tipo: string
Obrigatório: não

O nome de tipo de serviço usado para filtrar os serviços para consulta.

`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.

`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.

`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 serviços no cluster para o aplicativo especificado.	PagedServiceInfoList
Todos os outros códigos de status	A resposta de erro detalhada.	FabricError

Share via