Compartir a través de

Obtener información de aplicación implementada

  • Artículo

Obtiene la información sobre una aplicación implementada en un nodo de Service Fabric.

Esta consulta devuelve información de la aplicación del sistema si el identificador de aplicación proporcionado es para la aplicación del sistema. Los resultados abarcan las aplicaciones implementadas en los estados activo, activando y descargando. Esta consulta requiere que el nombre del nodo corresponda a un nodo en el clúster. La consulta produce un error si el nombre de nodo proporcionado no apunta a ningún nodo de Service Fabric activo en el clúster.

Solicitud

Método URI de solicitud
GET /Nodes/{nodeName}/$/GetApplications/{applicationId}?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}

Parámetros

Nombre Tipo Requerido Location
nodeName string Sí Ruta de acceso
applicationId string Sí Ruta de acceso
api-version string Sí Consultar
timeout entero (int64) No Consultar
IncludeHealthState boolean No Consultar

nodeName

Tipo: cadena
Obligatoria: sí

El nombre del nodo.

applicationId

Tipo: cadena
Obligatoria: sí

La identidad de la aplicación. Este suele ser el nombre completo de la aplicación sin el esquema de URI "fabric:" A partir de la versión 6.0, los nombres jerárquicos se delimitan con el carácter "~". Por ejemplo, si el nombre de la aplicación es "fabric:/myapp/app1", la identidad de la aplicación sería "myapp~app1" en 6.0+ y "myapp/app1" en las versiones anteriores.

api-version

Tipo: cadena
Obligatoria: sí
Predeterminado:

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

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 anterior, 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 compatible 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 tiempo de ejecución 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 documentada 6.0.

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.

IncludeHealthState

Tipo: booleano
Obligatoria: no
Predeterminado:

Incluir el estado de mantenimiento de una entidad. Si este parámetro es falso o no se especifica, el estado de mantenimiento devuelto es "Unknown". Cuando se establece en true, la consulta va en paralelo al nodo y al servicio del sistema de mantenimiento antes de que los resultados se combinen. Como resultado, la consulta es más costosa y puede tardar más tiempo.

Respuestas

Código de estado HTTP Descripción Esquema de respuesta
200 (OK) Una operación correcta devolverá el código de estado 200 y la información sobre la aplicación implementada.
 DeployedApplicationInfo
204 (NoContent) Se devuelve una respuesta vacía si la aplicación especificada no se implementa en el nodo.
Todos los demás códigos de estado Respuesta de error detallada.
 FabricError

Ejemplos

Obtener una aplicación implementada específica por identificador de aplicación e incluir el estado de mantenimiento en el resultado

En este ejemplo se muestra cómo obtener información sobre una aplicación implementada en un nodo especificado mediante un identificador de aplicación. Si se encuentra la aplicación, se devuelve la información con el código de estado 200. Se devuelve una respuesta vacía con el código de estado 204, si la aplicación especificada no se implementa en el nodo.

Request

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications/samples~CalculatorApp?api-version=6.1&IncludeHealthState=True

Respuesta 200

Cuerpo
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0.0",
  "Status": "Active",
  "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work",
  "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log",
  "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp",
  "HealthState": "Ok"
}

Respuesta 204

Cuerpo

El cuerpo de la respuesta está vacío.