API de Amazon EFS
La API de Amazon EFS es un protocolo de red basado en HTTP (RFC 2616)
La API de Amazon EFS es un modelo RPC. En este modelo, hay un conjunto fijo de operaciones y los clientes conocen la sintaxis de cada operación sin ninguna interacción previa. En la siguiente sección, encontrará una descripción de cada operación de API utilizando una notación RPC abstracta. Cada una tiene un nombre de operación que no aparece en la ruta. Para cada operación, el tema especifica el mapeo a los elementos de solicitud HTTP.
La operación de Amazon EFS concreta a la que se asigna una solicitud concreta se determina mediante una combinación del método de la solicitud (GET, PUT, POST o DELETE) y de cuáles de los distintos patrones coincide con su URI de solicitud. Si la operación es PUT o POST, Amazon EFS extrae los argumentos de llamada del segmento de la ruta URI de la solicitud, los parámetros de la consulta y el objeto JSON del cuerpo de la solicitud.
nota
Aunque los nombres de las operaciones, por ejemplo, CreateFileSystem, no aparecen en la red, son importantes en las políticas de AWS Identity and Access Management (IAM). Para obtener más información, consulte Administración de identidades y accesos para Amazon EFS.
Además, el nombre de operación se utiliza para nombrar los comandos en las herramientas de línea de comando y en los elementos de las API de SDK de AWS. Por ejemplo, existe un comando de la AWS CLI llamado create-file-system que se asocia a la operación CreateFileSystem.
El nombre de la operación también aparece en los registros de AWS CloudTrail para las llamadas a la API de Amazon EFS.
Punto de conexión de la API
El punto de enlace de la API es el nombre de DNS que se utiliza como host en el URI de HTTP de las llamadas al API. Estos puntos de enlace de la API son específicas de la Regiones de AWS y adoptan el siguiente formato.
elasticfilesystem.aws-region.amazonaws.com
Por ejemplo, el punto de conexión de la API de Amazon EFS para la región del Oeste de EE. UU. (Oregón) es el siguiente.
elasticfilesystem.us-west-2.amazonaws.com
Para ver una lista de las Región de AWS que admite Amazon EFS (en las que puede crear y administrar sistemas de archivos), consulte Amazon Elastic File System en la Referencia general de AWS.
El punto de conexión de la API específica de la región define el ámbito de los recursos de Amazon EFS que están accesibles al realizar una llamada a la API. Por ejemplo, si llama a la operación DescribeFileSystems mediante el punto de conexión anterior, obtendrá una lista de los sistemas de archivo de la región del Oeste de EE. UU. (Oregón) que se han creado en su cuenta.
Versión de API
La versión de API utilizada en una llamada se identifica mediante el primer segmento de la ruta de la URI de la solicitud y su formato es una fecha ISO 8601. Por ejemplo, consulte CreateFileSystem.
En la documentación se describe la versión 2015-02-01 del API.
Temas relacionados de
En las secciones siguientes proporcione descripciones de las operaciones de las API, cómo crear una firma para la solicitud de autenticación y cómo conceder permisos para dichas operaciones de API utilizando las políticas de IAM.
Trabajo con la velocidad de las solicitudes de API de consulta para Amazon EFS
Las solicitudes de API de Amazon EFS están limitadas para cada Cuenta de AWS por región con el fin de favorecer al rendimiento del servicio. Todas las llamadas a la API de Amazon EFS juntas, con independencia de que se deriven de una aplicación, la AWS CLI o la consola de Amazon EFS, no deben superar la velocidad máxima permitida para la API. La velocidad máxima de las solicitudes de API puede variar entre las Regiones de AWS. Las solicitudes de API se atribuyen a la Cuenta de AWS subyacente.
Si una solicitud de API supera la velocidad de las solicitudes de API en su categoría, la solicitud devuelve el código de error ThrottlingException. Para evitarlo, asegúrese de que la aplicación no reintenta las solicitudes de API a una velocidad elevada. Para ello, lleve a cabo el sondeo con precaución y emplee reintentos con retardo exponencial.
Sondeo
Es posible que la aplicación necesite llamar a una operación de API repetidamente para comprobar si hay alguna actualización de estado. Antes de comenzar el sondeo, indique el tiempo de solicitud para completarlo potencialmente. Cuando comience el sondeo, utilice un intervalo de suspensión adecuado entre las sucesivas solicitudes. Para obtener resultados óptimos, utilice un intervalo de suspensión creciente.
Reintentos o procesamiento por lotes
Es posible que la aplicación necesite volver a intentar una solicitud de API tras un error o para procesar varios recursos (por ejemplo, todos los sistemas de archivo de Amazon EFS). Para reducir la velocidad de solicitudes de API, utilice un intervalo de suspensión entre solicitudes sucesivas adecuado. Para obtener resultados óptimos, utilice un intervalo de suspensión creciente o variable.
Cálculo del intervalo de suspensión
Cuando tenga que sondear o reintentar una solicitud de API, recomendamos que utilice un algoritmo de retardo exponencial para calcular el intervalo de suspensión entre las llamadas al API. El retardo exponencial se basa en la idea de utilizar tiempos de espera progresivamente más largos entre reintentos para las respuestas a errores consecutivos. Para obtener más información, así como ejemplos de implementación de este algoritmo, consulte Reintentos de error y retroceso exponencial en AWS en la Referencia general de Amazon Web Services.
