Compartir a través de

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

  • Artículo

Obtiene la lista de tipos de aplicaciones del clúster de Service Fabric.

Devuelve la información sobre los tipos de aplicaciones aprovisionados o en proceso de aprovisionamiento en el clúster de Service Fabric. Cada versión de un tipo de aplicación se devuelve como tipo de aplicación. La respuesta incluye el nombre, la versión, el estado y otros detalles sobre el tipo de la aplicación. Se trata de una consulta paginada, lo que significa que, si no caben todos los tipos de aplicaciones en una página, se devuelve una página de resultados, así como un token de continuación que puede usarse para obtener la página siguiente. Por ejemplo, si hay diez tipos de aplicaciones, pero en una página solo caben tres o si el número máximo de resultados está establecido en tres, entonces solo se devuelven tres. Para acceder a los demás resultados, recupere las páginas siguientes con el token de continuación devuelto en la siguiente consulta. Si no existen páginas sucesivas, se devuelve un token de continuación vacío.

Solicitud

Método URI de solicitud
GET /ApplicationTypes?api-version=6.0&ApplicationTypeDefinitionKindFilter={ApplicationTypeDefinitionKindFilter}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

Parámetros

Nombre Tipo Requerido Location
api-version string Sí Consultar
ApplicationTypeDefinitionKindFilter integer No Consultar
ExcludeApplicationParameters boolean No Consultar
ContinuationToken string No Consultar
MaxResults entero (int64) 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 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.

ApplicationTypeDefinitionKindFilter

Tipo: entero
Obligatoria: no
Predeterminado:

Se usa para filtrar según ApplicationTypeDefinitionKind, que es el mecanismo utilizado para definir un tipo de aplicación de Service Fabric.

  • Valor predeterminado: valor predeterminado, que realiza la misma función que la selección de "Todo". El valor es 0.
  • All: filtro que coincide con la entrada con cualquier valor ApplicationTypeDefinitionKind. El valor es 65535.
  • ServiceFabricApplicationPackage: filtro que coincide con la entrada con el valor ApplicationTypeDefinitionKind ServiceFabricApplicationPackage. El valor es 1.
  • Compose: filtro que coincide con la entrada con el valor ApplicationTypeDefinitionKind Compose. El valor es 2.

ExcludeApplicationParameters

Tipo: booleano
Obligatoria: no
Predeterminado:

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

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.

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) Lista de tipos de aplicación en el clúster.
 PagedApplicationTypeInfoList
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 obtener información sobre los tipos de aplicación que se aprovisionan o que se aprovisionan en el clúster. El número de resultados de una página se limita al máximo de cinco mediante el parámetro MaxResult.

Request

GET http://localhost:19080/ApplicationTypes?api-version=6.0&MaxResults=5

Respuesta 200

Cuerpo
{
  "ContinuationToken": "PersistentQueueApp+2.0",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "ServiceInstanceCount",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "GatewayPort",
          "Value": "8505"
        },
        {
          "Key": "ServiceInstanceCount",
          "Value": "1000"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Página con token de continuación

En este ejemplo se muestra cómo paginar la información sobre los tipos de aplicación que se aprovisionan o que se aprovisionan en el clúster mediante 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 dos 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/ApplicationTypes?api-version=6.0&ContinuationToken=PersistentQueueApp+2.0&MaxResults=5

Respuesta 200

Cuerpo
{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [
        {
          "Key": "MinReplicaSetSize",
          "Value": "2"
        },
        {
          "Key": "TargetReplicaSetSize",
          "Value": "3"
        }
      ],
      "Status": "Available"
    }
  ]
}

Exclusión de parámetros de aplicación del resultado

En este ejemplo se muestra cómo excluir el parámetro de aplicación en el resultado al obtener la información sobre los tipos de aplicación que se aprovisionan o que se aprovisionan en el clúster.

Request

GET http://localhost:19080/ApplicationTypes?api-version=6.0&ExcludeApplicationParameters=True

Respuesta 200

Cuerpo
{
  "ContinuationToken": "",
  "Items": [
    {
      "Name": "CalculatorApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "CalculatorApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "GatewayApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "PersistentQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "1.0",
      "DefaultParameterList": [],
      "Status": "Available"
    },
    {
      "Name": "VolatileQueueApp",
      "Version": "2.0",
      "DefaultParameterList": [],
      "Status": "Available"
    }
  ]
}