API do Amazon EFS - Amazon Elastic File System

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

API do Amazon EFS

A API do Amazon EFS é um protocolo de rede com base em HTTP (RFC 2616). Para cada chamada de API, você faz uma solicitação de HTTP ao endpoint de API específico da Região da AWS onde deseja gerenciar os sistemas de arquivos. A API usa documentos JSON (RFC 4627) para órgãos de solicitação/resposta de HTTP.

A API do Amazon EFS é um modelo de RPC. Nesse modelo, há um conjunto fixo de operações, e os clientes conhecem a sintaxe de cada operação sem qualquer interação prévia. Na seção a seguir, você encontrará uma descrição de cada operação de API que usa uma notação abstrata de RPC. Cada uma tem um nome de operação que não aparece na rede. Para cada operação, o tópico especifica o mapeamento para elementos de solicitação de HTTP.

A operação do Amazon EFS específica para a qual certa solicitação é mapeada é determinada por uma combinação entre métodos de solicitação (EFS, GET, PUT ou DELETE) e diversos padrões aos quais seu URI de solicitação corresponde. Se a operação for PUT ou POST, o Amazon EFS extrai argumentos de chamada do segmento do caminho do URI da solicitação, parâmetros de consulta e o objeto JSON no corpo de solicitação.

nota

Embora os nomes de operação, como CreateFileSystem, não apareçam na rede, eles são significativos nas políticas do AWS Identity and Access Management (IAM). Para obter mais informações, consulte Gerenciamento de identidade e acesso para o Amazon EFS.

O nome da operação também é usado para nomear comandos em ferramentas de linha de comando e elementos das APIs do AWS SDK. Por exemplo, há um comando da AWS CLI chamado create-file-system que mapeia para a operação CreateFileSystem.

O nome da operação também aparece nos logs do AWS CloudTrail para chamadas de API do Amazon EFS.

Endpoints da API

Endpoint é um URL que funciona como ponto de entrada para um serviço da Web da AWS. O Amazon EFS comporta os seguintes tipos de endpoint:

Ao fazer uma solicitação, você pode especificar o endpoint a ser usado. Se você não especificar um endpoint, o endpoint IPv4 será usado por padrão. Para usar outro tipo de endpoint, você deve especificá-lo em sua solicitação. Para obter exemplos de como fazer isso, consulte Especificar endpoints. Para ver uma tabela de endpoints disponíveis, consulte Endpoints e cotas do Amazon EFS.

Endpoints IPv4

Endpoints IPv4 só são compatíveis com tráfego IPv4. Os endpoints IPv4 estão disponíveis em todas as regiões. O formato do endpoint IPv4 depende da região.

  • Em relação a endpoints IPv4 nas regiões comerciais da AWS, o formato é elasticfilesystem.region.amazonaws.com.

    Por exemplo, se você especificar elasticfilesystem.us-west-2.amazonaws.com como endpoint, direcionaremos sua solicitação para o endpoint da região do Oeste dos EUA (Oregon) (us-west-2).

  • Em relação a endpoints IPv4 nas regiões da China, o formato é elasticfilesystem.region.amazonaws.com.rproxy.govskope.ca.cn.

    Por exemplo, o endpoint da API do Amazon EFS para a região da China (Pequim) é elasticfilesystem---cn-north-1.amazonaws.com.rproxy.govskope.ca.cn.

Endpoints de pilha dupla (IPv4 e IPv6)

Endpoints de pilha dupla são compatíveis com tráfego IPv4 e IPv6. Quando você realiza uma solicitação para um endpoint de pilha dupla, o URL do endpoint decide por um endereço IPv6 ou IPv4, dependendo do protocolo usado pela rede e pelo cliente. O formato do endpoint de pilha dupla depende da região.

  • Em relação a endpoints de pilha dupla nas regiões comerciais da AWS, o formato é efs.aws-region.api.aws.

    Por exemplo, o endpoint de pilha dupla para a região do Oeste dos EUA (Oregon) (us-west-2) é efs.eu-west-2.api.aws.

  • Em relação a endpoints de pilha dupla nas regiões da China, o formato é efs.region.api.amazonwebservices.com.rproxy.govskope.ca.cn.

    Por exemplo, o endpoint de pilha dupla para a região da China (Pequim) é efs---cn-north-1---api.amazonwebservices.com.rproxy.govskope.ca.cn.

Especificar endpoints

Os exemplos a seguir mostram como especificar um endpoint para a região do Oeste dos EUA (N. da Califórnia) (us-west-1) usando a AWS CLI para o Amazon EFS.

IPv4

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

Pilha dupla

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

Versão da API

A versão da API que está sendo usada para uma chamada é identificada pelo primeiro segmento do caminho do URI da solicitação e tem o formato de data ISO 8601. Por exemplo, consulte CreateFileSystem.

A documentação descreve a versão da API de 2015-02-01.

As seções a seguir oferecem descrições das operações de API, como criar uma solicitação de assinatura para autenticação, e como conceder permissões para essas operações de API usando as políticas do IAM.

Trabalhar com a taxa de solicitações de APIs de consulta para o Amazon EFS

As solicitações de API do Amazon EFS são limitadas por região em cada conta da Conta da AWS para ajudar no desempenho do serviço. Todas as chamadas de API do Amazon EFS em conjunto, sejam elas originadas de um aplicativo, da AWS CLI ou do console do Amazon EFS, não devem exceder a taxa máxima de solicitação de API permitida. A taxa máxima de solicitação de API pode variar entre Regiões da AWS. As solicitações de API feitas são atribuídas à Conta da AWS subjacente.

Se uma solicitação de API exceder a taxa de solicitações de API da respectiva categoria, a solicitação retornará o código de erro ThrottlingException. Para evitar esse erro, verifique se o aplicativo não repete solicitações de API a uma taxa alta. Para fazer isso, tenha cuidado ao fazer a sondagem e use repetições de recuo exponencial.

Sondagem

O aplicativo pode precisar chamar uma operação da API várias vezes para verificar se há uma atualização no status. Antes de iniciar a sondagem, aguarde a conclusão da solicitação. Quando você iniciar a sondagem, use um intervalo de latência apropriado entre as solicitações sucessivas. Para obter os melhores resultados, use um intervalo de latência crescente.

Tentativas ou processamento em lote

O aplicativo pode precisar repetir uma solicitação de API depois que ela falhar ou processar vários recursos (por exemplo, todos os seus sistemas de arquivos do Amazon EFS). Para reduzir a taxa de solicitações de API, use um intervalo de latência apropriado entre as solicitações sucessivas. Para obter os melhores resultados, use um intervalo de latência crescente ou variável.

Calcular o intervalo de repouso

Quando você precisar fazer a sondagem ou repetir uma solicitação de API, é recomendável usar um algoritmo de recuo exponencial para calcular o intervalo de latência entre as chamadas de API. A ideia por trás do recuo exponencial é usar esperas progressivamente mais longas entre as novas tentativas para respostas de erro consecutivas. Para acessar mais informações e ver exemplos de implementação desse algoritmo, consulte Comportamento das novas tentativas no Referência geral da Amazon Web Services.