Syntaxe de la demande Paramètres de demande URI Corps de la demande Syntaxe de la réponse Eléments de réponse Erreurs Exemples consultez aussi

CreateFileSystem

Crée un nouveau système de fichiers vide. L’opération exige un jeton de création dans la demande qui est utilisé par Amazon EFS pour garantir la création idempotente (appeler l’opération avec le même jeton de création n’a aucun effet). S'il n'existe pas actuellement de système de fichiers appartenant à l'appelant Compte AWS avec le jeton de création spécifié, cette opération effectue les opérations suivantes :

Crée un nouveau système de fichiers vide. Le système de fichiers possède un ID attribué par Amazon EFS ainsi qu’un état du cycle de vie initial creating.
Retourne avec la description du système de fichiers créé.

Sinon, cette opération retourne une erreur FileSystemAlreadyExists avec l’ID du système de fichiers existant.

Note

Pour les cas d’utilisation de base, vous pouvez utiliser un UUID généré de façon aléatoire pour le jeton de création.

L’opération idempotente vous permet de relancer un appel CreateFileSystem sans risque de créer un système de fichiers supplémentaire. Cela peut se produire lorsqu’un appel initial échoue sans que vous puissiez savoir si un système de fichiers a été créé ou non. Par exemple, un délai d’attente au niveau du transport ou la réinitialisation de votre connexion. Tant que vous utilisez le même jeton de création, si l’appel initial a réussi à créer un système de fichiers, le client peut découvrir de son existence à partir de l’erreur FileSystemAlreadyExists.

Pour plus d’informations, consultez Création d’un système de fichiers dans le Guide de l’utilisateur Amazon EFS.

Note

L’appel CreateFileSystem se termine, tandis que l’état du cycle de vie du système de fichiers est toujours au statut creating. Vous pouvez vérifier le statut de création du système de fichiers en appelant l’opération DescribeFileSystems qui retourne l’état du système de fichiers, entre autres.

Cette opération accepte également un paramètre PerformanceMode facultatif que vous choisissez pour votre système de fichiers. Nous le recommandons generalPurpose PerformanceMode pour tous les systèmes de fichiers. Le maxIO mode est un type de performance de génération précédente conçu pour les charges de travail hautement parallélisées qui peuvent tolérer des latences plus élevées que le mode. generalPurpose MaxIOle mode n'est pas pris en charge pour les systèmes de fichiers One Zone ou les systèmes de fichiers qui utilisent le débit élastique.

Il ne PerformanceMode peut pas être modifié une fois le système de fichiers créé. Pour plus d’informations, consultez Amazon EFS : modes de performances.

Vous pouvez définir le mode de débit du système de fichiers à l’aide du paramètre ThroughputMode.

Une fois le système de fichiers entièrement créé, Amazon EFS définit son état du un cycle de vie available, après quoi vous pouvez créer une ou plusieurs cibles de Montage pour le système de fichiers de votre VPC. Pour de plus amples informations, veuillez consulter CreateMountTarget. Vous Montez votre système de fichiers Amazon EFS sur des instances EC2 dans votre VPC à l’aide de la cible de Montage. Pour plus d’informations, consultez Fonctionnement d’Amazon EFS.

Cette opération exige des autorisations pour l’action elasticfilesystem:CreateFileSystem.

Les systèmes de fichiers peuvent être étiquetés lors de leur création. Si les balises sont spécifiées dans l’action de création d’action, IAM effectue une autorisation supplémentaire sur l’action elasticfilesystem:TagResource pour vérifier si les utilisateurs sont autorisés à créer des balises. Par conséquent, vous devez octroyer des autorisations explicites d’utiliser l’action elasticfilesystem:TagResource. Pour plus d’informations, consultez Octroi d’autorisations pour baliser les ressources lors de la création.

Syntaxe de la demande


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"
}

Paramètres de demande URI

La demande n’utilise pas de paramètres URI.

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

AvailabilityZoneName

Pour les systèmes de fichiers One Zone, spécifiez la zone de AWS disponibilité dans laquelle créer le système de fichiers. Utilisez le format us-east-1a pour spécifier la Zone de disponibilité. Pour plus d'informations sur les systèmes de fichiers One Zone, consultez la section Types de systèmes de fichiers EFS dans le guide de l'utilisateur Amazon EFS.

Note

Les systèmes de fichiers One Zone ne sont pas disponibles dans toutes les zones de disponibilité dans Régions AWS lesquelles Amazon EFS est disponible.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

Modèle : .+

Obligatoire : non

Backup

Spécifie si les sauvegardes automatiques sont activées sur le système de fichiers que vous créez. Définissez la valeur sur true pour activer les sauvegardes automatiques. Si vous créez un système de fichiers Zone unique, les sauvegardes automatiques sont activées par défaut. Pour plus d’informations, consultez Sauvegardes automatiques dans le Guide de l’utilisateur Amazon EFS.

La valeur par défaut est false. Toutefois, si vous spécifiez un AvailabilityZoneName, la valeur par défaut est true.

Note

AWS Backup n'est pas disponible partout Régions AWS où Amazon EFS est disponible.

Type : booléen

Obligatoire : non

CreationToken

Chaîne de maximum 64 caractères ASCII. Amazon EFS l’utilise pour garantir la création idempotente.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

Modèle : .+

Obligatoire : oui

Encrypted

Une valeur booléenne qui, si elle est vraie, crée un système de fichiers chiffré. Lorsque vous créez un système de fichiers chiffré, vous avez la possibilité de spécifier une AWS Key Management Service clé existante (clé KMS). Si vous ne spécifiez pas de clé KMS, la clé KMS par défaut pour Amazon EFS, /aws/elasticfilesystem, est utilisée pour protéger le système de fichiers chiffré.

Type : booléen

Obligatoire : non

KmsKeyId

L’ID de la clé KMS que vous souhaitez utiliser pour protéger le système de fichiers crypté. Ce paramètre est obligatoire uniquement si vous souhaitez utiliser une clé KMS personnalisée. Si ce paramètre n’est pas spécifié, la clé KMS par défaut pour Amazon EFS est utilisée. Vous pouvez spécifier un ID de clé KMS en utilisant les formats suivants :

ID de clé - Identifiant unique de la clé, par exemple 1234abcd-12ab-34cd-56ef-1234567890ab.
ARN - Amazon Resource Name (ARN) pour la clé, par exemple arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias de clé - Un nom d’affichage précédemment créé pour une clé, par exemple alias/projectKey1.
ARN d’alias de clé - ARN pour un alias de clé, par exemple arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

Si vous l'utilisezKmsKeyId, vous devez définir le paramètre CreateFileSystem:Encrypted sur true.

Important

EFS n’accepte que les clés KMS symétriques. Vous ne pouvez pas utiliser de clés KMS asymétriques avec les systèmes de fichiers Amazon EFS.

Type : chaîne

Contraintes de longueur : longueur maximale de 2048.

Modèle : ^([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/_-]+))))$

Obligatoire : non

PerformanceMode

Mode de performances du système de fichiers. Nous recommandons le mode performance generalPurpose pour tous les systèmes de fichiers. Les systèmes de fichiers utilisant le mode de performance maxIO peuvent évoluer vers des niveaux plus élevés de débit cumulé et d’opérations par seconde avec comme contrepartie des latences légèrement plus élevées pour la plupart des opérations de fichier. Le mode de performances ne peut pas être Modifié une fois que le système de fichiers a été créé. Le mode maxIO n’est pas pris en charge sur les systèmes de fichiers utilisant des classes de stockage Zone unique.

Important

En raison des latences par opération plus élevées avec Max E/S, nous recommandons d’utiliser le mode de performance Usage général pour tous les systèmes de fichiers.

La valeur par défaut est generalPurpose.

Type : chaîne

Valeurs valides : generalPurpose | maxIO

Obligatoire : non

ProvisionedThroughputInMibps

Débit, mesuré en mébioctets par seconde (MiBps), que vous souhaitez allouer au système de fichiers que vous créez. Obligatoire si ThroughputMode est défini sur provisioned. Les valeurs valides sont comprises entre 1 et 3414 MiBps, la limite supérieure dépendant de la région. Pour augmenter cette limite, contactez AWS Support. Pour plus d’informations, consultez Quotas Amazon EFS que vous pouvez augmenter dans le Guide de l’utilisateur Amazon EFS.

Type : double

Plage valide : valeur minimum de 1,0.

Obligatoire : non

Tags

Utilisez cette valeur pour créer une ou plusieurs balises associées au système de fichiers. Chaque balise est une paire clé-valeur définie par l’utilisateur. Nommez votre système de fichiers au moment de la création en incluant une paire clé-valeur "Key":"Name","Value":"{value}". Chaque clé doit être unique. Pour plus d'informations, consultez la section AWS Ressources relatives au balisage dans le Guide de référence AWS général.

Type : tableau d’objets Tag

Obligatoire : non

ThroughputMode

Spécifie le mode de débit du système de fichiers. Il peut s’agir du mode bursting, provisioned ou elastic. Si vous définissez ThroughputMode sur provisioned, vous devez également définir une valeur pour ProvisionedThroughputInMibps. Après avoir créé le système de fichiers, vous pouvez réduire son débit en mode Débit alloué ou passer d’un mode de débit à l’autre, avec certaines restrictions de temps. Pour de plus amples informations, consultez Spécification du débit avec le mode alloué dans le Guide de l’utilisateur Amazon EFS.

La valeur par défaut est bursting.

Type : chaîne

Valeurs valides : bursting | provisioned | elastic

Obligatoire : non

Syntaxe de la réponse


HTTP/1.1 201
Content-type: application/json

{
   "AvailabilityZoneId": "string",
   "AvailabilityZoneName": "string",
   "CreationTime": number,
   "CreationToken": "string",
   "Encrypted": boolean,
   "FileSystemArn": "string",
   "FileSystemId": "string",
   "FileSystemProtection": { 
      "ReplicationOverwriteProtection": "string"
   },
   "KmsKeyId": "string",
   "LifeCycleState": "string",
   "Name": "string",
   "NumberOfMountTargets": number,
   "OwnerId": "string",
   "PerformanceMode": "string",
   "ProvisionedThroughputInMibps": number,
   "SizeInBytes": { 
      "Timestamp": number,
      "Value": number,
      "ValueInArchive": number,
      "ValueInIA": number,
      "ValueInStandard": number
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "ThroughputMode": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 201.

Les données suivantes sont renvoyées au format JSON par le service.

AvailabilityZoneId

Identifiant unique et cohérent de la Zone de disponibilité dans laquelle se trouve le système de fichiers, valide uniquement pour les systèmes de fichiers Zone unique. Par exemple, use1-az1 il s'agit d'un identifiant de zone de disponibilité pour le Région AWS us-east-1, qui possède le même emplacement dans chaque cas. Compte AWS

Type : chaîne

AvailabilityZoneName

Décrit la zone de AWS disponibilité dans laquelle se trouve le système de fichiers et n'est valide que pour les systèmes de fichiers One Zone. Pour de plus amples informations, consultez Utilisation de classes de stockage EFS dans le Guide de l’utilisateur Amazon EFS.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

Modèle : .+

CreationTime

Heure de création du système de fichiers, en secondes (depuis 1970-01-01T 00:00:00 Z).

Type : Timestamp

CreationToken

Chaîne opaque spécifiée dans la demande.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64.

Modèle : .+

Encrypted

Valeur booléenne qui, si la valeur est true, indique que le système de fichiers est chiffré.

Type : booléen

FileSystemArn

Le nom de ressource Amazon Resource Name (ARN) pour le système de fichiers EFS, au format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id. Exemple avec des exemples de données : arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

Type : chaîne

FileSystemId

ID du système de fichiers, attribué par Amazon EFS.

Type : chaîne

Contraintes de longueur : Longueur maximum de 128.

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

FileSystemProtection

Décrit la protection du système de fichiers.

Type : objet FileSystemProtectionDescription

KmsKeyId

Identifiant AWS KMS key utilisé pour protéger le système de fichiers chiffré.

Type : chaîne

Contraintes de longueur : longueur maximale de 2048.

LifeCycleState

Phase du cycle de vie du système de fichiers.

Type : chaîne

Name

Vous pouvez ajouter des balises à un système de fichiers, y compris une balise Name. Pour de plus amples informations, veuillez consulter CreateFileSystem. Si le système de fichiers possède une balise Name, Amazon EFS renvoie la valeur dans ce champ.

Type : chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

NumberOfMountTargets

Le nombre actuel de cibles de Montage du système de fichiers. Pour de plus amples informations, veuillez consulter CreateMountTarget.

Type : entier

Plage valide : Valeur minimum de 0.

OwnerId

Celui Compte AWS qui a créé le système de fichiers.

Type : chaîne

Contraintes de longueur : longueur maximale de 14.

Modèle : ^(\d{12})|(\d{4}-\d{4}-\d{4})$

PerformanceMode

Mode de performances du système de fichiers.

Type : chaîne

Valeurs valides : generalPurpose | maxIO

ProvisionedThroughputInMibps

Quantité de débit allouée, mesurée en MiBps, pour le système de fichiers. Valable pour les systèmes de fichiers utilisant ThroughputMode définit sur provisioned.

Type : double

Plage valide : Valeur minimum de 1,0.

SizeInBytes

La dernière taille mesurée connue (en octets) des données stockées dans le système de fichiers, dans son champ Value, et l’heure à laquelle cette taille a été déterminée dans son champ Timestamp. La valeur Timestamp est le nombre entier de secondes écoulées depuis 1970-01-01T 00:00:00 Z. La valeur SizeInBytes ne représente pas la taille d’un instantané cohérent du système de fichiers, mais elle est finalement cohérente lorsqu’aucune écriture n’est effectuée dans le système de fichiers. Cela signifie que SizeInBytes représente la taille réelle uniquement si le système de fichiers n’est pas Modifié pendant une période supérieure à deux heures. Dans le cas contraire, la valeur ne correspond pas exactement à la taille du système de fichiers à un Moment donné.

Type : objet FileSystemSize

Tags

Tags associés au système de fichiers, présentés sous forme de tableau des objets Tag.

Type : tableau d’objets Tag

ThroughputMode

Affiche le mode de débit du système de fichiers. Pour plus d’informations, consultez les Modes de débit dans le Guide de l’utilisateur Amazon EFS.

Type : chaîne

Valeurs valides : bursting | provisioned | elastic

Erreurs

BadRequest

Renvoyé si la demande est mal formée ou contient une erreur telle qu’une valeur de paramètre non valide ou un paramètre obligatoire manquant.

Code d’état HTTP : 400

FileSystemAlreadyExists

Renvoyé si le système de fichiers que vous essayez de créer existe déjà, avec le jeton de création que vous avez fourni.

Code d’état HTTP : 409

FileSystemLimitExceeded

Renvoie si le nombre maximum de systèmes de fichiers autorisés par compte Compte AWS a déjà été créé.

Code d’état HTTP : 403

InsufficientThroughputCapacity

Renvoyé si la capacité est insuffisante pour fournir un débit supplémentaire. Cette valeur peut être renvoyée lorsque vous essayez de créer un système de fichiers en mode débit alloué, lorsque vous essayez d’augmenter le débit alloué d’un système de fichiers existant ou lorsque vous essayez de faire passer un système de fichiers existant du mode débit en rafale au mode débit alloué. Réessayez ultérieurement.

HTTP Status Code: 503

InternalServerError

Renvoyé si une erreur s’est produite côté serveur.

Code d’état HTTP : 500

ThroughputLimitExceeded

Renvoie si le mode de débit ou la quantité de débit alloué ne peuvent pas être Modifiés car la limite de débit de 1024 Mbits/s a été atteinte.

Code d’état HTTP : 400

UnsupportedAvailabilityZone

Renvoyé si la fonctionnalité Amazon EFS demandée n’est pas disponible dans la Zone de disponibilité spécifiée.

Code d’état HTTP : 400

Exemples

Créez d’un système de fichiers EFS

L’exemple suivant envoie une requête POST pour créer un système de fichiers dans la région us-west-2 avec les sauvegardes automatiques activées. La demande est spécifiée myFileSystem1 comme jeton de création pour l’idempotencie.

Exemple de demande


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"
      }
   ]
}

Exemple de réponse


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": 29313618372,
       "ValueInArchive": 201156,
       "ValueInIA": 675432,
       "ValueInStandard": 29312741784
   },
   "Tags":[
      {
        "Key": "Name",
        "Value": "Test Group1"
      }
   ],
   "ThroughputMode": "elastic"
}

Créer un système de fichiers EFS chiffré avec disponibilité de Zone unique

L’exemple suivant envoie une requête POST pour créer un système de fichiers dans la région us-west-2 avec les sauvegardes automatiques activées. Le système de fichiers disposera d’un espace de stockage Zone unique dans la zone de us-west-2b disponibilité .

Exemple de demande


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": "elastic",
  "Tags":[
      {
         "Key": "Name",
         "Value": "Test Group1"
      }
   ]
}

Exemple de réponse


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,
   "SizeInBytes":{
       "Timestamp": 1403301078,
       "Value": 29313618372,
       "ValueInArchive": 201156,
       "ValueInIA": 675432,
       "ValueInStandard": 29312741784
   },
   "Tags":[
      {
        "Key": "Name",
        "Value": "Test Group1"
      }
   ],
   "ThroughputMode": "elastic"
}

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

CreateAccessPoint

CreateMountTarget