Partilhar via

Comando Invocar Infraestrutura

  • Artigo

Invoca um comando administrativo na instância do Serviço de Infraestrutura especificada.

Para clusters com uma ou mais instâncias do Serviço de Infraestrutura configuradas, esta API fornece uma forma de enviar comandos específicos da infraestrutura para uma instância específica do Serviço de Infraestrutura.

Os comandos disponíveis e os formatos de resposta correspondentes variam consoante a infraestrutura em que o cluster está em execução.

Esta API suporta a plataforma do Service Fabric; não se destina a ser utilizado diretamente a partir do seu código.

Pedir

Método URI do pedido
POST /$/InvokeInfrastructureCommand?api-version=6.0&Command={Command}&ServiceId={ServiceId}&timeout={timeout}

Parâmetros

Nome Tipo Necessário Localização
api-version string Yes Consulta
Command string Yes Consulta
ServiceId cadeia (de carateres) No Consulta
timeout número inteiro (int64) No Consulta

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 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 inferior da API, 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. Por isso, se a versão mais recente da API for a 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á de acordo com a versão 6.0 documentada.

Command

Tipo: cadeia
Obrigatório: Sim

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

ServiceId

Tipo: cadeia
Obrigatório: Não

A identidade do serviço de infraestrutura. Este é o nome completo do serviço de infraestrutura sem o esquema de URI "fabric:". Este parâmetro só é necessário para o cluster que tem mais do que uma instância do serviço de infraestrutura em execução.

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 que a operação pedida seja concluída. O valor predefinido para este parâmetro é 60 segundos.

Respostas

Código de Estado HTTP Description Esquema de Resposta
200 (OK) A resposta do serviço de infraestrutura. O formato de resposta é um fluxo JSON.
Os conteúdos da resposta dependem do comando que foi emitido.
 string
Todos os outros códigos de estado A resposta detalhada ao erro.
 FabricError