Obter Descrição do Serviço

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. Tem de ser criado um serviço para que a respetiva descrição possa ser obtida.

Pedir

Método URI do pedido
GET /Services/{serviceId}/$/GetDescription?api-version=6.0&timeout={timeout}

Parâmetros

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

serviceId

Tipo: cadeia
Obrigatório: Sim

A identidade do serviço. Normalmente, este ID é o nome completo do serviç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 do serviço for "fabric:/myapp/app1/svc1", a identidade do serviço será "myapp~app1~svc1" em 6.0+ e "myapp/app1/svc1" 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 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.


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