Obtener la lista de información de tipo de aplicación por nombre
Obtiene la lista de tipos de aplicaciones del clúster de Service Fabric que coinciden exactamente con el nombre especificado.
Devuelve la información sobre los tipos de aplicaciones aprovisionados o en proceso de aprovisionamiento en el clúster de Service Fabric. Estos resultados son los tipos de aplicaciones cuyo nombre coincide exactamente con el especificado como parámetro y que coinciden con los parámetros de consulta establecidos. Se devuelven todas las versiones del tipo de aplicación que coinciden con el nombre del tipo de aplicación, y cada versión se devuelve como un 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/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout} |
Parámetros
| Nombre | Tipo | Requerido | Location |
|---|---|---|---|
applicationTypeName |
string | Sí | Ruta de acceso |
api-version |
string | Sí | Consultar |
ApplicationTypeVersion |
string | No | Consultar |
ExcludeApplicationParameters |
boolean | No | Consultar |
ContinuationToken |
string | No | Consultar |
MaxResults |
entero (int64) | No | Consultar |
timeout |
entero (int64) | No | Consultar |
applicationTypeName
Tipo: cadena
Obligatoria: sí
Nombre del tipo de aplicación.
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.
ApplicationTypeVersion
Tipo: cadena
Obligatoria: no
La versión del tipo de aplicación.
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 |