Compartir a través de

Obtener la lista de información de aplicación implementada

  • Artículo

Obtiene la lista de las aplicaciones implementadas en un nodo de Service Fabric.

Obtiene la lista de las aplicaciones implementadas en un nodo de Service Fabric. Los resultados no incluyen información sobre las aplicaciones de sistema implementadas a menos que el ID lo solicite explícitamente. 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?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}

Parámetros

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

nodeName

Tipo: cadena
Obligatoria: sí

El nombre del nodo.

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.

ContinuationToken

Tipo: cadena
Obligatoria: no

El parámetro continuation token se utiliza para obtener el siguiente conjunto de resultados. Un token de continuación con un valor no vacío se incluye en la respuesta de la API cuando los resultados del sistema no caben en una única respuesta. Cuando este valor se pasa a la siguiente llamada de la API, la API devuelve el siguiente conjunto de resultados. Si no hay más resultados, el token de continuación no contiene ningún valor. El valor de este parámetro no debe ser la dirección URL codificada.

MaxResults

Tipo: entero (int64)
Obligatoria: no
Predeterminado:
InclusiveMinimum: 0

El número máximo de resultados que se devuelven como parte de las consultas paginadas. Este parámetro define el límite superior en el número de resultados devueltos. Los resultados devueltos pueden ser menos que el número máximo de resultados especificado si no caben en el mensaje según las restricciones del tamaño máximo del mensaje definidas en la configuración. Si este parámetro es cero o no se especifica, la consulta paginada incluye tantos resultados como quepan en el mensaje devuelto.

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 lista de información de la aplicación implementada.
 PagedDeployedApplicationInfoList
Todos los demás códigos de estado Respuesta de error detallada.
 FabricError

Ejemplos

Limitar los resultados máximos

En este ejemplo se muestra cómo especificar el número de aplicaciones devueltas por la consulta al obtener información sobre las aplicaciones implementadas en un nodo específico. El número de resultados en una página se limita al máximo de 2 mediante el parámetro MaxResult. El estado de mantenimiento no se solicita en este ejemplo, por lo que el estado de mantenimiento devuelto será Desconocido.

Request

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&MaxResults=2

Respuesta 200

Cuerpo
{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Unknown"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Página con token de continuación

En este ejemplo se muestra la funcionalidad de paginación disponible al obtener información sobre las aplicaciones implementadas en un nodo específico. En este ejemplo se usa el parámetro ContinuationToken. El valor de este parámetro se proporciona a partir de la consulta anterior; en este caso, el ejemplo mostrado anteriormente. La respuesta contiene los resultados restantes y un ContinuationToken vacío. El objeto ContinuationToken vacío indica que los resultados adicionales no están disponibles.

Request

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1

Respuesta 200

Cuerpo
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Unknown"
    }
  ]
}

Incluir el estado de mantenimiento en el resultado

En este ejemplo se muestra cómo incluir el estado de mantenimiento de cada aplicación implementada al obtener información sobre las aplicaciones implementadas en un nodo específico.

Request

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

Respuesta 200

Cuerpo
{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Ok"
    }
  ]
}