CreateFileSystem - Amazon Elastic File System
Sintaxe da SolicitaçãoParâmetros da solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosExemplosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

CreateFileSystem

Cria um novo sistema de arquivos vazio. A operação requer um token de criação na solicitação que o Amazon EFS usa para garantir a criação idempotente (chamar a operação com o mesmo token de criação não tem efeito). Se não existir atualmente um sistema de arquivos pertencente ao chamador Conta da AWS com o token de criação especificado, essa operação faz o seguinte:

  • Cria um novo sistema de arquivos vazio. O sistema de arquivos terá um ID atribuído pelo Amazon EFS e um estado de ciclo de vida inicial de creating.

  • Retorna com a descrição do sistema de arquivos criado.

Caso contrário, essa operação retornará um erro FileSystemAlreadyExists com o ID do sistema de arquivos existente.

nota

Para casos de uso básicos, você pode usar um UUID gerado aleatoriamente para o token de criação.

A operação idempotente permite que você tente novamente uma chamada à CreateFileSystem sem o risco de criar um sistema de arquivos extra. Isso pode acontecer quando há uma falha na chamada inicial de uma forma que deixa dúvida sobre se um sistema de arquivos foi realmente criado. Um exemplo pode ser a ocorrência um tempo limite de nível de transporte ou a redefinição de sua conexão. Desde que você use o mesmo token de criação, se a chamada inicial tiver criado um sistema de arquivos com êxito, o cliente poderá saber de sua existência a partir do erro FileSystemAlreadyExists.

Para obter mais informações, consulte Criar um sistema de arquivos no Guia do usuário do Amazon EFS.

nota

A chamada de CreateFileSystem retorna enquanto o estado do ciclo de vida do sistema de arquivos ainda for creating. Você pode verificar o status da criação do sistema de arquivos chamando a operação DescribeFileSystems que, entre outras coisas, retorna o estado do sistema de arquivos.

Essa operação também aceita um parâmetro PerformanceMode opcional que você escolhe para seu sistema de arquivos. Recomendamos PerformanceMode generalPurpose para todos os sistemas de arquivos. O maxIO modo é um tipo de desempenho da geração anterior, projetado para cargas de trabalho altamente paralelizadas que podem tolerar latências mais altas do que o modo. generalPurpose MaxIOo modo não é compatível com sistemas de arquivos One Zone ou sistemas de arquivos que usam Elastic throughput.

O PerformanceMode não pode ser alterado depois que o sistema de arquivos tiver sido criado. Para obter mais informações, consulte Modos de performance do Amazon EFS.

Você pode definir o modo de throughput do sistema de arquivos usando o parâmetro ThroughputMode.

Quando o sistema de arquivos estiver totalmente criado, o Amazon EFS definirá seu estado de ciclo de vida como available. Nesse ponto, você pode criar um ou mais destinos de montagem para o sistema de arquivos em sua VPC. Para ter mais informações, consulte CreateMountTarget. Você monta o sistema de arquivos do Amazon EFS em instâncias do EC2 em sua VPC usando o destino de montagem. Para obter mais informações, consulte Amazon EFS: como ele funciona.

Essa operação exige permissões para a ação elasticfilesystem:CreateFileSystem.

Os sistemas de arquivos podem ser marcados na criação. Se tags forem especificadas na ação de criação, o IAM realizará autorização adicional na ação elasticfilesystem:TagResource para verificar se os usuários têm permissões para criar tags. Portanto, os usuários também precisam ter permissões para usar a ação elasticfilesystem:TagResource. Para obter mais informações, consulte Conceder permissões para marcar recursos durante a criação.

Sintaxe da Solicitação

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 da solicitação de URI

A solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

AvailabilityZoneName

Para sistemas de arquivos One Zone, especifique a zona de disponibilidade da AWS na qual criar o sistema de arquivos. Use o formato us-east-1a para especificar a zona de disponibilidade. Para obter mais informações sobre sistemas de arquivos One Zone, consulte Tipos de sistema de arquivos EFS no Guia do usuário do Amazon EFS.

nota

Os sistemas de arquivos de uma zona não estão disponíveis em todas as zonas de disponibilidade nas Regiões da AWS quais o Amazon EFS está disponível.

Tipo: sequência

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.

Padrão: .+

Obrigatório: não

Backup

Especifica se os backups automáticos estão habilitados no sistema de arquivos que você está criando. Defina o valor true para habilitar backups automáticos. Se você estiver criando um sistema de arquivos One Zone, os backups automáticos estão habilitados por padrão. Para obter mais informações, consulte Backups automáticos no Guia do usuário do Amazon EFS.

O padrão é false. No entanto, se você especificar um AvailabilityZoneName, o padrão será true.

nota

AWS Backup não está disponível em todos os Regiões da AWS locais onde o Amazon EFS está disponível.

Tipo: booliano

Obrigatório: não

CreationToken

Uma sequência de até 64 caracteres ASCII. O Amazon EFS usa isso para garantir a criação de idempotência.

Tipo: sequência

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.

Padrão: .+

Exigido: Sim

Encrypted

Um valor booliano que, quando é verdadeiro, cria um sistema de arquivos criptografado. Ao criar um sistema de arquivos criptografado, você tem a opção de especificar uma AWS Key Management Service chave existente (chave KMS). Se você não especificar uma chave do KMS, a chave do KMS padrão para o Amazon EFS, /aws/elasticfilesystem, será usada para proteger o sistema de arquivos criptografado.

Tipo: booliano

Obrigatório: não

KmsKeyId

O ID da chave do KMS a ser usada para proteger o sistema de arquivos criptografado. Esse parâmetro é necessário somente se você quiser usar uma chave do KMS não padrão. Se esse parâmetro não for especificado, a chave do KMS padrão para o Amazon EFS será usada. Você pode especificar esse ID da chave KMS usando os formatos a seguir:

  • ID da chave – um identificador exclusivo da chave, por exemplo, 1234abcd-12ab-34cd-56ef-1234567890ab.

  • ARN – um nome de recurso da Amazon (ARN) para a chave, por exemplo, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Alias da chave: um nome de exibição criado anteriormente para uma chave, por exemplo, alias/projectKey1.

  • ARN do alias da chave – um ARN para um alias da chave, por exemplo, arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

Se você usarKmsKeyId, deverá definir o parâmetro CreateFileSystem:Encrypted como verdadeiro.

Importante

O EFS apenas aceita chaves do KMS simétricas. Você não pode usar chaves KMS assimétricas com sistemas de arquivos Amazon EFS.

Tipo: sequência

Restrições de tamanho: tamanho máximo de 2.048.

Padrão: ^([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/_-]+))))$

Obrigatório: não

PerformanceMode

O modo de desempenho do sistema de arquivos. Recomendamos o modo de desempenho generalPurpose para todos os sistemas de arquivos. Os sistemas de arquivos que estão usando o modo de desempenho maxIO podem ser dimensionados para níveis mais altos de throughput e operações agregadas por segundo, fornecendo, em troca, latências um pouco mais altas para a maioria das operações de arquivo. O modo de desempenho não pode ser alterado depois que o sistema de arquivos tiver sido criado. O modo maxIO não é compatível em sistemas de arquivos One Zone.

Importante

Devido às maiores latências por operação com Max I/O, recomendamos usar o modo de desempenho de uso geral para todos os sistemas de arquivos.

O padrão é generalPurpose.

Tipo: sequências

Valores Válidos: generalPurpose | maxIO

Obrigatório: não

ProvisionedThroughputInMibps

A taxa de transferência, medida em mebibytes por segundo (MiBps), que você deseja provisionar para um sistema de arquivos que você está criando. Necessário se ThroughputMode estiver definido como provisioned. Os valores válidos são de 1 a 3414 MiBps, com o limite superior dependendo da região. Para aumentar esse limite, entre em contato AWS Support. Para obter mais informações, consulte Cotas do Amazon EFS que você pode aumentar no Guia do usuário do Amazon EFS.

Tipo: duplo

Faixa válida: valor mínimo de 1.0.

Obrigatório: não

Tags

Use para criar uma ou mais tags associadas ao sistema de arquivos. Cada tag é um par de chave-valor definido pelo usuário. Nomeie seu sistema de arquivos na criação, incluindo um par de chave-valor "Key":"Name","Value":"{value}". Cada chave deve ser exclusiva. Para obter mais informações, consulte AWS Recursos de marcação no Guia de referência AWS geral.

Tipo: matriz de objetos Tag

Obrigatório: não

ThroughputMode

Especifica o modo de throughput do sistema de arquivos. O modo pode ser bursting, provisioned ou elastic. Ao definir ThroughputMode como provisioned, você também deve definir um valor para ProvisionedThroughputInMibps. Depois de criar o sistema de arquivos, você pode diminuir o throughput Provisioned do sistema de arquivos ou alterar entre os modos de throughput, com certas restrições de tempo. Para obter mais informações, consulte Especificando o throughput com o modo provisionado no Guia do usuário do Amazon EFS.

O padrão é bursting.

Tipo: sequências

Valores Válidos: bursting | provisioned | elastic

Obrigatório: Não

Sintaxe da Resposta

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

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 201.

Os dados a seguir são retornados no formato JSON pelo serviço.

AvailabilityZoneId

O identificador exclusivo e consistente da zona de disponibilidade na qual o sistema de arquivos está localizado e é válido somente para sistemas de arquivos One Zone. Por exemplo, use1-az1 é um ID de zona de disponibilidade para Região da AWS us-east-1 e tem a mesma localização em todos. Conta da AWS

Tipo: sequência

AvailabilityZoneName

Descreve a zona de AWS disponibilidade na qual o sistema de arquivos está localizado e é válido somente para sistemas de arquivos de uma zona. Para obter mais informações, consulte Usar classes de armazenamento EFS no Guia do usuário do Amazon EFS.

Tipo: sequência

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.

Padrão: .+

CreationTime

A hora em que o sistema de arquivos foi criado, em segundos (desde 1970-01-01T 00:00:00 Z).

Tipo: carimbo de data/hora

CreationToken

A string opaca especificada na solicitação.

Tipo: sequência

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.

Padrão: .+

Encrypted

Um valor booliano que, quando verdadeiro, indica que o sistema de arquivos é criptografado.

Tipo: booliano

FileSystemArn

O nome do recurso da Amazon (ARN) para o sistema de arquivos do Amazon EFS no formato arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Exemplo com dados de amostra: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

Tipo: sequência

FileSystemId

O ID do sistema de arquivos, atribuído pelo Amazon EFS.

Tipo: sequência

Restrições de tamanho: tamanho máximo de 128.

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

FileSystemProtection

Descreve a proteção no sistema de arquivos.

Tipo: objeto FileSystemProtectionDescription

KmsKeyId

O ID de um AWS KMS key usado para proteger o sistema de arquivos criptografados.

Tipo: sequência

Restrições de tamanho: tamanho máximo de 2.048.

Padrão: ^([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

A fase do ciclo de vida do sistema de arquivos.

Tipo: sequências

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

Name

Você pode adicionar tags a um sistema de arquivos, incluindo uma tag Name. Para ter mais informações, consulte CreateFileSystem. Se o sistema de arquivos tiver uma tag Name, o Amazon EFS retornará o valor nesse campo.

Tipo: sequência

Restrições de tamanho: o tamanho máximo é 256.

Padrão: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

NumberOfMountTargets

O número atual de destinos de montagem que o sistema de arquivos tem. Para ter mais informações, consulte CreateMountTarget.

Tipo: inteiro

Intervalo válido: valor mínimo de 0.

OwnerId

O Conta da AWS que criou o sistema de arquivos.

Tipo: sequência

Restrições de tamanho: tamanho máximo de 14.

Padrão: ^(\d{12})|(\d{4}-\d{4}-\d{4})$

PerformanceMode

O modo de desempenho do sistema de arquivos.

Tipo: sequências

Valores Válidos: generalPurpose | maxIO

ProvisionedThroughputInMibps

A quantidade de taxa de transferência provisionada, medida em MiBps, para o sistema de arquivos. Válido para sistemas de arquivos usando ThroughputMode definido como provisioned.

Tipo: duplo

Faixa válida: valor mínimo de 1.0.

SizeInBytes

O último tamanho medido conhecido (em bytes) dos dados armazenados no sistema de arquivos, em seu campo Value, e a hora em que esse tamanho foi determinado em seu campo Timestamp. O valor Timestamp é o número inteiro de segundos desde 1970-01-01T 00:00:00 Z. O valor SizeInBytes não representa o tamanho de um instantâneo consistente do sistema de arquivos, mas acaba sendo consistente quando não há gravações no sistema de arquivos. Ou seja, SizeInBytes representa o tamanho real somente se o sistema de arquivos não for modificado por um período superior a algumas horas. Caso contrário, o valor não é o tamanho exato que o sistema de arquivos tinha em algum momento.

Tipo: objeto FileSystemSize

Tags

As tags associadas ao sistema de arquivos, apresentadas como uma matriz de objetos de Tag.

Tipo: matriz de objetos Tag

ThroughputMode

Mostra o modo de taxa de transferência para um sistema de arquivos. Para obter mais informações, consulte Modos de throughput no Guia do usuário do Amazon EFS.

Tipo: sequências

Valores Válidos: bursting | provisioned | elastic

Erros

BadRequest

Retornado se a solicitação estiver malformada ou contiver um erro, como um valor de parâmetro inválido ou um parâmetro obrigatório ausente.

Código de Status HTTP: 400

FileSystemAlreadyExists

Retornado se o sistema de arquivos que você está tentando criar já existir, com o token de criação fornecido.

Código de Status HTTP: 409

FileSystemLimitExceeded

Retornado se o já Conta da AWS tiver criado o número máximo de sistemas de arquivos permitidos por conta.

Código de Status HTTP: 403

InsufficientThroughputCapacity

Retornado se não houver capacidade suficiente para provisionar throughput adicional. Esse valor pode ser retornado ao tentar criar um sistema de arquivos no modo de taxa de transferência provisionada, ao tentar aumentar a taxa de transferência provisionada de um sistema de arquivos existente ou ao tentar alterar um sistema de arquivos existente do modo de taxa de transferência intermitente para o modo de taxa de transferência provisionada. Tente novamente mais tarde.

Código de status HTTP: 503

InternalServerError

Retornado se ocorreu um erro no lado do servidor.

Código de Status HTTP: 500

ThroughputLimitExceeded

Retornado se o modo de taxa de transferência ou a quantidade de taxa de transferência provisionada não puderem ser alterados porque o limite de taxa de transferência de 1024 MiB/s foi atingido.

Código de Status HTTP: 400

UnsupportedAvailabilityZone

Retornado se a funcionalidade solicitada do Amazon EFS não estiver disponível na zona de disponibilidade especificada.

Código de Status HTTP: 400

Exemplos

Criar um sistema de arquivos EFS criptografado

O exemplo a seguir envia uma solicitação POST para criar um sistema de arquivos na região us-west-2 com backups automáticos ativados. A solicitação especifica myFileSystem1 como o token de criação para idempotência.

Exemplo de solicitação

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

Resposta da amostra

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

Criar um sistema de arquivos EFS criptografado com disponibilidade One Zone

O exemplo a seguir envia uma solicitação POST para criar um sistema de arquivos na região us-west-2 com backups automáticos ativados. O sistema de arquivos terá armazenamento One Zone na zona de disponibilidade us-west-2b.

Exemplo de solicitação

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

Resposta da amostra

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

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: