API de Amazon EFS - Amazon Elastic File System

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

API de Amazon EFS

La API de Amazon EFS es un protocolo de red basado en HTTP (RFC 2616). Para cada llamada a la API, se realiza una solicitud HTTP al punto de conexión de la API de Amazon EFS para la Región de AWS en la que desee administrar los sistemas de archivos. La API utiliza documentos JSON (RFC 4627) para el cuerpo de las solicitudes y respuestas HTTP.

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.

Puntos de enlace de API

Un punto de conexión es una URL que sirve como punto de entrada para un servicio web de AWS. Amazon EFS admite los siguientes tipos de puntos de conexión:

Al realizar una solicitud, puede especificar el punto de conexión que se va a utilizar. Si no especifica un punto de conexión, se utilizará de forma predeterminada el punto de conexión IPv4. Para utilizar un tipo de punto de conexión diferente, debe especificarlo en la solicitud. Para ver ejemplos prácticos, consulte Especificación de puntos de conexión. Para ver una tabla de los puntos de conexión disponibles, consulte Puntos de conexión y cuotas de Amazon EFS.

Puntos de conexión IPv4

Los puntos de conexión IPv4 solo son compatibles con el tráfico IPv4. Los puntos de conexión IPv4 están disponibles para todas las regiones. El formato del punto de conexión IPv4 depende de la región.

  • Para los puntos de conexión IPv4 en las regiones comerciales de AWS, el formato es elasticfilesystem.region.amazonaws.com.

    Por ejemplo, si especifica elasticfilesystem.us-west-2.amazonaws.com como punto de conexión, dirigimos su solicitud al punto de conexión de la región Oeste de EE. UU. (Oregón) (us-west-2).

  • Para los puntos de conexión IPv4 en las regiones de China, el formato es elasticfilesystem.region.amazonaws.com.rproxy.govskope.ca.cn.

    Por ejemplo, el punto de conexión de la API de Amazon EFS para la región de China (Pekín) es elasticfilesystem---cn-north-1.amazonaws.com.rproxy.govskope.ca.cn.

Puntos de conexión de doble pila (IPv4 e IPv6)

Los puntos de conexión de doble pila admiten tráfico IPv4 e IPv6. Cuando hace una solicitud a un punto de conexión de doble pila, la URL del punto de conexión se resuelve en una dirección IPv6 o IPv4, según el protocolo que utilicen la red y el cliente. El formato del punto de conexión de doble pila depende de la región.

  • Para los puntos de conexión de doble pila en las regiones comerciales de AWS, el formato es efs.aws-region.api.aws.

    Por ejemplo, efs.eu-west-2.api.aws es el punto de conexión de doble pila para la región Oeste de EE. UU. (Oregón) (us-west-2).

  • Para los puntos de conexión de doble pila en las regiones de China, el formato es efs.region.api.amazonwebservices.com.rproxy.govskope.ca.cn.

    Por ejemplo, el punto de conexión de doble pila para la región China (Pekín) es efs---cn-north-1---api.amazonwebservices.com.rproxy.govskope.ca.cn.

Especificación de puntos de conexión

En los ejemplos siguientes, se muestra cómo especificar un punto de conexión para la región Oeste de EE. UU. (Norte de California) (us-west-1) mediante la AWS CLI para Amazon EFS.

IPv4

aws efs get-rest-apis --region us-west-1 --endpoint-url https://elasticfilesystem.us-west-1.amazonaws.com

Doble pila

aws efs get-rest-apis --region us-west-1 --endpoint-url https://efs.us-west-1.api.aws

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.

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 Comportamiento de los reintentos en la Referencia general de Amazon Web Services.