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, debe realizar una solicitud HTTP al punto de enlace de la API de Amazon EFS específico de la región en la Región de AWS que desea 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

Si bien los nombres de las operaciones, por ejemploCreateFileSystem, no aparecen en la red, estos nombres son significativos en las políticas AWS Identity and Access Management (de IAM). Para obtener más información, consulte Administración de identidades y accesos para Amazon EFS.

El nombre de la operación también se usa para nombrar los comandos de las herramientas y los elementos de la línea de comandos del SDK. AWS APIs Por ejemplo, hay un nombre de AWS CLI comando create-file-system que se asigna a la CreateFileSystem operación.

El nombre de la operación también aparece en AWS CloudTrail los registros de las llamadas a la API de Amazon EFS.

Puntos de enlace de API

Un punto final es una URL que sirve como punto de entrada para un servicio AWS web. 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 final, se usa el IPv4 punto final de forma predeterminada. 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 enlace disponibles, consulte los puntos de enlace y las cuotas de Amazon EFS.

IPv4 puntos de enlace

IPv4 los puntos finales solo admiten IPv4 tráfico. IPv4 los puntos finales están disponibles en todas las regiones. El formato del IPv4 punto final depende de la región.

  • Para los IPv4 puntos finales de las regiones AWS comerciales, el formato eselasticfilesystem.region.amazonaws.com.

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

  • Para los IPv4 puntos finales de las regiones de China, el formato eselasticfilesystem.region.amazonaws.com.cn.

    Por ejemplo, el punto de enlace de la API Amazon EFS para la región de China (Pekín) eselasticfilesystem.cn-north-1.amazonaws.com.cn.

Puntos de enlace de doble pila (IPv4 y IPv6)

Los puntos finales de doble pila admiten tanto el tráfico como el tráfico. IPv4 IPv6 Al realizar una solicitud a un punto final de doble pila, la URL del punto final se convierte en una IPv6 o una IPv4 dirección, según el protocolo utilizado por la red y el cliente. El formato del punto final de doble pila depende de la región.

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

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

  • Para los puntos finales de doble pila en las regiones de China, el formato es. efs.region.api.amazonwebservices.com.cn

    Por ejemplo, el punto final de doble pila para la región de China (Pekín) esefs.cn-north-1.api.amazonwebservices.com.cn.

Especificación de puntos de conexión

Los siguientes ejemplos muestran cómo especificar un punto final para la región EE.UU. Oeste (Norte de California) (us-west-1) mediante AWS CLI 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 la 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 se limitan para cada una de ellas por región para mejorar Cuenta de AWS el rendimiento del servicio. Todas las llamadas a la API de Amazon EFS juntas, independientemente de que se originen en una aplicación, en la AWS CLI consola de Amazon EFS o en la consola de Amazon EFS, no deben superar la tasa máxima de solicitudes de API permitida. La tasa máxima de solicitudes de API puede variar de un país a otro Regiones de AWS. Las solicitudes de API realizadas se atribuyen a las subyacentes Cuenta de AWS.

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 y ejemplos de implementación de este algoritmo, consulte el comportamiento de reintento en el Referencia general de Amazon Web Services.