Compartir a través de

Invoke Infrastructure (Comando)

  • Artículo

Invoca un comando administrativo en la instancia del servicio de infraestructura determinada.

Para los clústeres que tienen una o varias instancias del servicio de infraestructura configurado, esta API proporciona una manera de enviar comandos específicos de la infraestructura a una instancia determinada del servicio de infraestructura.

Los comandos disponibles y sus formatos de respuesta correspondientes variarán en función de la infraestructura en la que se ejecute el clúster.

Esta API es compatible con la plataforma Service Fabric; no está diseñada para utilizarse directamente desde el código.

Solicitud

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

Parámetros

Nombre Tipo Requerido Location
api-version string Sí Consultar
Command string Sí Consultar
ServiceId string No Consultar
timeout entero (int64) No Consultar

api-version

Tipo: cadena
Obligatoria: sí
Predeterminado:

La versión de la API. Este parámetro es necesario y su valor debe ser "6.0".

La versión de la API rest de Service Fabric se basa en la versión en tiempo de ejecución en la que se introdujo o se cambió la API. El entorno de ejecución de Service Fabric admite más de una versión de la API. Esta es la versión compatible más reciente de la API. Si se pasa una versión de API inferior, la respuesta devuelta puede ser diferente de la documentada en esta especificación.

Además, el tiempo de ejecución acepta cualquier versión superior a la versión admitida más reciente hasta la versión actual del entorno de ejecución. Por lo tanto, si la versión más reciente de la API es 6.0, pero si el runtime es 6.1, para facilitar la escritura de los clientes, el entorno de ejecución aceptará la versión 6.1 para esa API. Sin embargo, el comportamiento de la API será según la versión 6.0 documentada.

Command

Tipo: cadena
Obligatoria: sí

El texto del comando que se va a invocar. El contenido del comando es específico de la infraestructura.

ServiceId

Tipo: cadena
Obligatoria: no

La identidad del servicio de infraestructura. Este es el nombre completo del servicio de infraestructura sin el esquema de URI "fabric". Este parámetro solo es obligatorio para el clúster que tiene en ejecución más de una instancia del servicio de infraestructura.

timeout

Tipo: entero (int64)
Obligatoria: no
Predeterminado:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

Tiempo de espera del servidor para realizar la operación en segundos. Este tiempo de espera especifica el tiempo que el cliente está dispuesto a esperar a que se complete la operación solicitada. El valor predeterminado para este parámetro es 60 segundos.

Respuestas

Código de estado HTTP Descripción Esquema de respuesta
200 (OK) Respuesta del servicio de infraestructura. El formato de respuesta es una secuencia JSON.
El contenido de la respuesta depende del comando que se emitió.
 string
Todos los demás códigos de estado Respuesta de error detallada.
 FabricError