CreateFileSystem - 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.

CreateFileSystem

Crea un nuevo sistema de archivos vacío. La operación requiere un token de creación en la solicitud que Amazon EFS usa para garantizar la creación idempotent (llamar a la operación con el mismo token de creación no tiene ningún efecto). Si actualmente no existe un sistema de archivos que pertenece al interlocutor Cuenta de AWS con el token de creación especificado, esta operación hace lo siguiente:

  • Crea un nuevo sistema de archivos vacío. El sistema de archivos tendrá un ID de Amazon EFS asignado y un estado de ciclo de vida inicial de creating.

  • Se devuelve con la descripción del sistema de archivos creado.

De lo contrario, esta operación devuelve un error FileSystemAlreadyExists con el ID del sistema de archivos existente.

nota

Para casos de uso básicos, puede utilizar un UUID generado de forma aleatoria para el token de creación.

La operación idempotent le permite volver a intentar una llamada CreateFileSystem sin riesgo de crear un sistema de archivos adicional. Esto puede ocurrir cuando una llamada inicial produce un error de forma que queda la incertidumbre de si se creó o no un sistema de archivos. Por ejemplo, se agotó el tiempo de espera de nivel de transporte o se restableció la conexión. Siempre que utilice el mismo token de creación, si la llamada inicial hubiera realizado con éxito la creación de un sistema de archivos, el cliente puede deducir su existencia a partir del error FileSystemAlreadyExists.

Para obtener más información, consulteCreación de un sistema de archivosen laGuía del usuario de Amazon EFS.

nota

La llamada CreateFileSystem realiza devuelve información mientras el estado de ciclo de vida del sistema de archivos siga siendo creating. Puede comprobar el estado de creación del sistema de archivos llamando al DescribeFileSystems , que entre otras cosas devuelve el estado del sistema de archivos.

Esta operación acepta una opción opcionalPerformanceModeque elige para el sistema de archivos. Recomendamos el modo de rendimiento generalPurpose para la mayoría de sistemas de archivos. Los sistemas de archivos que utilizan el modo de rendimiento maxIO pueden escalar a niveles superiores de rendimiento total y operaciones por segundo, con la contrapartida de que la latencia es un poco mayor en la mayoría de las operaciones con archivos. El modo de rendimiento no se puede cambiar después de haber creado el sistema de archivos. Para obtener más información, consulteModos de rendimiento Amazon EFS.

Puede establecer el modo de rendimiento para el sistema de archivos mediante elThroughputModeparámetro.

Una vez que se ha creado totalmente el sistema de archivos, Amazon EFS establece su estado de ciclo de vida en available. A partir de ese momento puede crear uno o varios destinos de montaje para el sistema de archivos en la VPC. Para obtener más información, consulte CreateMountTarget . Monte su sistema de archivos de Amazon EFS en instancias EC2 en su VPC a través de los destinos de montaje. Para obtener más información, consulteAmazon EFS: Funcionamiento.

Esta operación necesita permisos para la acción elasticfilesystem:CreateFileSystem.

Sintaxis de la solicitud

POST /2015-02-01/file-systems HTTP/1.1 Content-type: application/json { "AvailabilityZoneName": "string", "Backup": boolean, "CreationToken": "string", "Encrypted": boolean, "KmsKeyId": "string", "PerformanceMode": "string", "ProvisionedThroughputInMibps": number, "Tags": [ { "Key": "string", "Value": "string" } ], "ThroughputMode": "string" }

Parámetros de solicitud del URI

La solicitud no utiliza ningún parámetro de URI.

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

AvailabilityZoneName

Se usa para crear un sistema de archivos que utiliza clases de almacenamiento de Única zona. Especifica elAWSLa zona de disponibilidad en la que se debe crear el sistema de archivos. Utilice el formato us-east-1a para especificar la zona de disponibilidad. Para obtener más información acerca de las clases de almacenamiento de Única zona, consulte Uso de clases de almacenamiento EFS en la Guía del usuario de Amazon EFS.

nota

Las clases de almacenamiento de Única zona no están disponibles en todas las zonas de disponibilidad de Regiones de AWS donde Amazon EFS está disponible.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es 64.

Patrón: .+

Obligatorio: No

Backup

Especifica si las copias de seguridad automáticas están habilitadas en el sistema de archivos que está creando. Defina el valor de entruepara habilitar copias de seguridad automáticas. Si va a crear un sistema de archivos que utiliza clases de almacenamiento de Única zona, las copias de seguridad automáticas se habilitan de forma predeterminada. Para obtener más información, consulteCopias de seguridad automáticasen laGuía del usuario de Amazon EFS.

El valor predeterminado es false. Sin embargo, si especifica unAvailabilityZoneName, el valor predeterminado estrue.

nota

AWS Backupno está disponible en todos Regiones de AWS donde Amazon EFS está disponible.

Type: Booleano

Obligatorio: No

CreationToken

Cadena de hasta 64 caracteres ASCII. Amazon EFS utiliza esto para garantizar la creación de idempotentes.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es 64.

Patrón: .+

Obligatorio: Sí

Encrypted

Un valor booleano que, si es verdadero, crea un sistema de archivos cifrado. Al crear un sistema de archivos cifrados, tiene la opción de especificarCrear sistema de archivos: KMS KeyIDde un existenteAWS Key Management Service(AWS KMSclave maestra del cliente (CMK). Si no especifica una CMK, se utiliza la CMK predeterminada para Amazon EFS, /aws/elasticfilesystem, para proteger el sistema de archivos cifrado.

Type: Booleano

Obligatorio: No

KmsKeyId

El ID de laAWS KMSCMK que desea utilizar para proteger el sistema de archivos cifrados. Este parámetro solo es necesario si desea utilizar una clave KMS que no sea la predeterminada. Si no se especifica este parámetro, se utiliza la CMK predeterminada para Amazon EFS. Este ID puede tener uno de los siguientes formatos:

  • ID de clave: un identificador único de la clave, por ejemplo 1234abcd-12ab-34cd-56ef-1234567890ab.

  • ARN: un nombre de recurso de Amazon (ARN) para la clave, por ejemplo arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Alias de clave: un nombre de visualización creado con anterioridad para una clave, por ejemplo alias/projectKey1.

  • ARN de alias de clave: un ARN para un alias de clave, por ejemplo arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

SiKmsKeyIdse especifica, elCrear sistema de archivos: encriptadoEl parámetro debe establecerse en true.

importante

EFS solo acepta claves KMS simétricas. No se pueden utilizar claves KMS asimétricas con sistemas de archivos EFS.

Type: Cadena

Restricciones de longitud: La longitud máxima es de 2048 caracteres.

Patrón: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$

Obligatorio: No

PerformanceMode

El modo de desempeño del sistema de archivos. Recomendamos el modo de rendimiento generalPurpose para la mayoría de sistemas de archivos. Los sistemas de archivos que utilizan el modo de rendimiento maxIO pueden escalar a niveles superiores de rendimiento total y operaciones por segundo, con la contrapartida de que la latencia es un poco mayor en la mayoría de las operaciones con archivos. El modo de rendimiento no se puede cambiar después de haber creado el sistema de archivos.

nota

El modo maxIO no es compatible con los sistemas de archivos que utilizan clases de almacenamiento de Única zona.

Type: Cadena

Valores válidos: generalPurpose | maxIO

Obligatorio: No

ProvisionedThroughputInMibps

El aprovisionamiento, medido en MiB/s, que desea proporcionar para el sistema de archivos que está creando. Los valores válidos son del 1 al 1024. Obligatorio si ThroughputMode se establece en provisioned. El límite superior de rendimiento es 1024 MiB/s. Para aumentar este límite, póngase en contacto con AWS Support. Para obtener más información, consulte Cuotas de Amazon EFS que puede incrementar en la Guía del usuario de Amazon EFS.

Type: Double

Rango válido: Valor mínimo de 1.0.

Obligatorio: No

Tags

Se usa para crear una o varias etiquetas asociadas al sistema de archivos. Las etiquetas son pares clave-valor que define el usuario. Asigne un nombre al sistema de archivos en el momento de su creación mediante la inclusión de un par clave-valor "Key":"Name","Value":"{value}". Cada clave debe ser única. Para obtener más información, consulteEtiquetadoAWSrecursosen la AWSGuía de referencia general de.

Type: Matriz de Tag objects

Obligatorio: No

ThroughputMode

Especifica el modo de rendimiento del sistema de archivos, bursting o provisioned. Si establece ThroughputMode en provisioned, también debe establecer un valor para ProvisionedThroughputInMibps. Después de crear el sistema de archivos, puede disminuir el nivel de rendimiento del sistema de archivos en el modo del nivel de rendimiento aprovisionado o alternar los modos de rendimiento, siempre que hayan transcurrido más de 24 horas desde que se modificó la última disminución o modo de rendimiento. Para obtener más información, consulte Especificación del rendimiento con el modo aprovisionado en la Guía del usuario de Amazon EFS.

El valor predeterminado es bursting.

Type: Cadena

Valores válidos: bursting | provisioned

Obligatorio: No

Sintaxis de la respuesta

HTTP/1.1 201 Content-type: application/json { "AvailabilityZoneId": "string", "AvailabilityZoneName": "string", "CreationTime": number, "CreationToken": "string", "Encrypted": boolean, "FileSystemArn": "string", "FileSystemId": "string", "KmsKeyId": "string", "LifeCycleState": "string", "Name": "string", "NumberOfMountTargets": number, "OwnerId": "string", "PerformanceMode": "string", "ProvisionedThroughputInMibps": number, "SizeInBytes": { "Timestamp": number, "Value": number, "ValueInIA": number, "ValueInStandard": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "ThroughputMode": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 201.

El servicio devuelve los datos siguientes en formato JSON.

AvailabilityZoneId

Identificador único y coherente de la zona de disponibilidad en la que existen las clases de almacenamiento One Zone del sistema de archivos. Por ejemplo,use1-az1es un ID de zona de disponibilidad para us-east-1 Región de AWS , y tiene la misma ubicación en cada Cuenta de AWS .

Type: Cadena

AvailabilityZoneName

Describe elAWSZona de disponibilidad en la que se encuentra el sistema de archivos y solo es válida para sistemas de archivos que utilizan clases de almacenamiento One Zone. Para obtener más información, consulteUso de EFS clases de almacenamiento deen laGuía del usuario de Amazon EFS.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es 64.

Patrón: .+

CreationTime

El tiempo en que se creó el sistema de archivos, en segundos (desde 1970-01-01T 00:00:00 Z).

Type: Marca temporal

CreationToken

La cadena opaca especificada en la solicitud.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es 64.

Patrón: .+

Encrypted

Un valor booleano que, si es verdadero, indica que el sistema de archivos está cifrado.

Type: Booleano

FileSystemArn

Nombre de recurso de Amazon (ARN) para el sistema de archivos EFS, en el formatoarn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Ejemplo con datos de ejemplo:arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

Type: Cadena

FileSystemId

El ID del sistema de archivos asignado por Amazon EFS.

Type: Cadena

Restricciones de longitud: La longitud máxima es de 128 caracteres.

Patrón: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$

KmsKeyId

El ID de unAWS Key Management ServiceLa clave principal del cliente (CMK) que se utilizó para proteger el sistema de archivos cifrados.

Type: Cadena

Restricciones de longitud: La longitud máxima es de 2048 caracteres.

Patrón: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$

LifeCycleState

Fase del ciclo de vida del sistema de archivos.

Type: Cadena

Valores válidos: creating | available | updating | deleting | deleted | error

Name

Puede agregar etiquetas a un sistema de archivos, incluido unNameetiqueta. Para obtener más información, consulte CreateFileSystem . Si el sistema de archivos tiene unNameetiqueta, Amazon EFS devuelve el valor de este campo.

Type: Cadena

Restricciones de longitud: La longitud máxima es de 256 caracteres.

Patrón: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

NumberOfMountTargets

Número actual de destinos de montaje que tiene el sistema de archivos. Para obtener más información, consulte CreateMountTarget .

Type: Entero

Rango válido: Valor mínimo de 0.

OwnerId

La Cuenta de AWS que creó el sistema de archivos. Si el sistema de archivos fue creado por un usuario de IAM, la cuenta principal a la que pertenece el usuario es el propietario.

Type: Cadena

Restricciones de longitud: La longitud máxima es de 14 caracteres.

Patrón: ^(\d{12})|(\d{4}-\d{4}-\d{4})$

PerformanceMode

El modo de desempeño del sistema de archivos.

Type: Cadena

Valores válidos: generalPurpose | maxIO

ProvisionedThroughputInMibps

La cantidad de rendimiento aprovisionado, medido en MiB/s, del sistema de archivos. Válido para sistemas de archivos que utilizanThroughputModeEstablecer comoprovisioned.

Type: Double

Rango válido: Valor mínimo de 1.0.

SizeInBytes

El último tamaño medido conocido (en bytes) de datos almacenados en el sistema de archivos, en suValuey el momento en que se determinó ese tamaño en suTimestamp. LaTimestampvalue es el número entero de segundos desde 1970-01-01T 00:00:00 Z. LaSizeInBytesvalue no representa el tamaño de una instantánea coherente del sistema de archivos, pero finalmente es coherente cuando no hay escrituras en el sistema de archivos. Es decir,SizeInBytesrepresenta el tamaño real solo si el sistema de archivos no se modifica durante un período superior a un par de horas. De lo contrario, el valor no es el tamaño exacto que tenía el sistema de archivos en ningún momento.

Tipo: objeto FileSystemSize

Tags

Las etiquetas asociadas al sistema de archivos presentadas como una matriz deTagobjetos.

Type: Matriz de Tag objects

ThroughputMode

Muestra el modo de rendimiento del sistema de archivos. Para obtener más información, consulteModos de desempeñoen laGuía del usuario de Amazon EFS.

Type: Cadena

Valores válidos: bursting | provisioned

Errors

BadRequest

Se devuelve si la solicitud está mal formada o contiene un error, como un valor de parámetro no válido o un parámetro obligatorio que falta.

Código de estado HTTP: 400

FileSystemAlreadyExists

Devuelto si el sistema de archivos que intenta crear ya existe, con el token de creación que proporcionó.

Código de estado HTTP: 409

FileSystemLimitExceeded

Devuelta si el parámetro Cuenta de AWS ya ha creado el número máximo de sistemas de archivos permitidos por cuenta.

Código de estado HTTP: 403

InsufficientThroughputCapacity

Se devuelve si no hay suficiente capacidad para aprovisionar un rendimiento adicional. Este valor se puede devolver cuando intenta crear un sistema de archivos en modo de rendimiento aprovisionado, cuando intenta aumentar el rendimiento aprovisionado de un sistema de archivos existente o cuando intenta cambiar un sistema de archivos existente de fragmentación a modo de rendimiento aprovisionado. Inténtelo de nuevo más tarde.

Código de estado HTTP: 503

InternalServerError

Se devuelve si se ha producido un error en el lado del servidor.

Código de estado HTTP: 500

ThroughputLimitExceeded

Se devuelve si no se puede cambiar el modo de rendimiento o la cantidad de rendimiento aprovisionado porque se ha alcanzado el límite de rendimiento de 1024 MIB/s.

Código de estado HTTP: 400

UnsupportedAvailabilityZone

Se devuelve si la funcionalidad de Amazon EFS solicitada no está disponible en la zona de disponibilidad especificada.

Código de estado HTTP: 400

Examples

Crear un sistema de archivos EFS cifrado

En el siguiente ejemplo, se envía una solicitud POST para crear un sistema de archivos en elus-west-2Región con copias de seguridad automáticas habilitadas. La solicitud especificamyFileSystem1como símbolo de creación para la idempotencia.

Solicitud de muestra

POST /2015-02-01/file-systems HTTP/1.1 Host: elasticfilesystem.us-west-2.amazonaws.com x-amz-date: 20140620T215117Z Authorization: <...> Content-Type: application/json Content-Length: 42 { "CreationToken" : "myFileSystem1", "PerformanceMode" : "generalPurpose", "Backup": true, "Encrypted": true, "Tags":[ { "Key": "Name", "Value": "Test Group1" } ] }

Respuesta de ejemplo

HTTP/1.1 201 Created x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef Content-Type: application/json Content-Length: 319 { "ownerId":"251839141158", "CreationToken":"myFileSystem1", "Encrypted": true, "PerformanceMode" : "generalPurpose", "fileSystemId":"fs-01234567", "CreationTime":"1403301078", "LifeCycleState":"creating", "numberOfMountTargets":0, "SizeInBytes":{ "Timestamp": 1403301078, "Value": 29313417216, "ValueInIA": 675432, "ValueInStandard": 29312741784 }, "Tags":[ { "Key": "Name", "Value": "Test Group1" } ], "ThroughputMode": "bursting" }

Crear un sistema de archivos EFS cifrado que use clases de almacenamiento de Única zona

En el siguiente ejemplo, se envía una solicitud POST para crear un sistema de archivos en elus-west-2Región con copias de seguridad automáticas habilitadas. El sistema de archivos tendrá redundancia de almacenamiento One Zone en elus-west-2bAvailability Zone.

Solicitud de muestra

POST /2015-02-01/file-systems HTTP/1.1 Host: elasticfilesystem.us-west-2.amazonaws.com x-amz-date: 20140620T215117Z Authorization: <...> Content-Type: application/json Content-Length: 42 { "CreationToken" : "myFileSystem2", "PerformanceMode" : "generalPurpose", "Backup": true, "AvailabilityZoneName": "us-west-2b", "Encrypted": true, "ThroughputMode": "provisioned", "ProvisionedThroughputInMibps": 60, "Tags":[ { "Key": "Name", "Value": "Test Group1" } ] }

Respuesta de ejemplo

HTTP/1.1 201 Created x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef Content-Type: application/json Content-Length: 319 { "ownerId":"251839141158", "CreationToken":"myFileSystem1", "Encrypted": true, "AvailabilityZoneId": "usew2-az2", "AvailabilityZoneName": "us-west-2b", "PerformanceMode" : "generalPurpose", "fileSystemId":"fs-01234567", "CreationTime":"1403301078", "LifeCycleState":"creating", "numberOfMountTargets":0, "ProvisionedThroughputInMibps": 60, "SizeInBytes":{ "Timestamp": 1403301078, "Value": 29313417216, "ValueInIA": 675432, "ValueInStandard": 29312741784 }, "Tags":[ { "Key": "Name", "Value": "Test Group1" } ], "ThroughputMode": "provisioned" }

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: