Share via

Obter descrição de serviço

  • Artigo

Obtém a descrição de um serviço do Service Fabric existente.

Obtém a descrição de um serviço do Service Fabric existente. É necessário criar um serviço para poder obter sua descrição.

Solicitação

Método URI da solicitação
GET /Services/{serviceId}/$/GetDescription?api-version=6.0&timeout={timeout}

Parâmetros

Nome Tipo Obrigatório Location
serviceId string Sim Caminho
api-version string Sim Consulta
timeout inteiro (int64) Não Consulta

serviceId

Tipo: string
Obrigatório: sim

A identidade do serviço. Normalmente, essa ID é o nome completo do serviço sem o esquema de 'malha' do URI. A partir da versão 6.0, nomes hierárquicos são delimitados pelo caractere "~". Por exemplo, se o nome do serviço for "fabric:/myapp/app1/svc1", a identidade do serviço será "myapp~app1~svc1" na versão 6.0 e superiores e and "myapp/app1/svc1" em 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.

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) Uma operação bem-sucedida retornará 200 status código.
 ServiceDescription
Todos os outros códigos de status A resposta de erro detalhada.
 FabricError