Invocar consulta de infraestrutura

  • Artigo

Invoca uma consulta de somente leitura na instância do serviço de infraestrutura especificada.

Para clusters que têm uma ou mais instâncias do serviço de infraestrutura configurado, essa API fornece uma maneira para enviar consultas de infraestrutura específicos para uma determinada instância do serviço de infraestrutura.

Comandos disponíveis e seus formatos de resposta correspondentes variam de acordo com a infraestrutura na qual o cluster está em execução.

Essa API dá suporte à plataforma do Service Fabric; não é destinada a ser usada diretamente a partir do seu código.

Solicitação

Método URI da solicitação
GET /$/InvokeInfrastructureQuery?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout}

Parâmetros

Nome Type Obrigatório Location
api-version string Sim Consulta
Command string Sim Consulta
ServiceId string Não Consulta
timeout inteiro (int64) Não 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 é baseada na versão de runtime na qual a API foi introduzida ou 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 nessa especificação.

Além disso, o runtime aceita qualquer versão 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.

Command

Tipo: string
Obrigatório: sim

O texto do comando a ser invocado. O conteúdo do comando é específico da infraestrutura.

ServiceId

Tipo: string
Obrigatório: não

A identidade do serviço de infraestrutura. É o nome completo do serviço de infraestrutura sem o esquema de URI "fabric:". Esse parâmetro é necessário somente para clusters que têm mais de uma instância do serviço de infraestrutura em execução.

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) A resposta do serviço de infraestrutura. O formato de resposta é um fluxo JSON.
O conteúdo da resposta depende de qual comando foi emitido.
 string
Todos os outros códigos status A resposta de erro detalhada.
 FabricError