Compartir a través de

Obtener información de la aplicación

  • Artículo

Obtiene la información sobre una aplicación de Service Fabric.

Devuelve la información sobre la aplicación que se creó o que está en proceso de creación en el clúster de Service Fabric y cuyo nombre coincide con el especificado como parámetro. La respuesta incluye el nombre, el tipo, el estado, los parámetros y otros detalles sobre la aplicación.

Solicitud

Método URI de solicitud
GET /Applications/{applicationId}?api-version=6.0&ExcludeApplicationParameters={ExcludeApplicationParameters}&timeout={timeout}

Parámetros

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

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.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 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.

ExcludeApplicationParameters

Tipo: booleano
Obligatoria: no
Predeterminado:

La marca que especifica si los parámetros de la aplicación se excluirán del resultado.

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) Información sobre la aplicación.
 ApplicationInfo
204 (NoContent) Se devuelve una respuesta vacía si no se encuentra el applicationId especificado en el clúster.
Todos los demás códigos de estado Respuesta de error detallada.
 FabricError

Ejemplos

Obtención de una aplicación específica por identificador de aplicación

En este ejemplo se muestra cómo obtener información sobre una aplicación mediante su identificador. Si se encuentra la aplicación, se devuelve información sobre ella con el código de estado 200. Si no se encuentra la aplicación, se devuelve contenido vacío con el código de estado 204.

Request

GET http://localhost:19080/Applications/samples~CalculatorApp?api-version=6.0

Respuesta 200

Cuerpo
{
  "Id": "samples~CalculatorApp",
  "Name": "fabric:/samples/CalculatorApp",
  "TypeName": "CalculatorApp",
  "TypeVersion": "1.0",
  "Status": "Ready",
  "Parameters": [
    {
      "Key": "CalculatorAppParameter1",
      "Value": "314"
    },
    {
      "Key": "CalculatorAppParameter2",
      "Value": "271"
    }
  ],
  "HealthState": "Ok",
  "ApplicationDefinitionKind": "ServiceFabricApplicationDescription"
}

Respuesta 204

Cuerpo

El cuerpo de la respuesta está vacío.