本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Amazon EFS API
<a name="api-reference"></a>

Amazon EFS API 是以 [HTTP (RFC 2616)](https://www.ietf.org/rfc/rfc2616.txt) 為基礎的網路通訊協定。對於每次 API 呼叫，您都會對要管理檔案系統的 的區域特定 Amazon EFS API 端點提出 HTTP AWS 區域 請求。此 API 會將 JSON (RFC 4627) 文件用於 HTTP 請求/回應內文。

Amazon EFS API 是一種 RPC 模型。在此模型中有一組固定的操作，且每個操作的語法無須任何事先互動即會對用戶端公開。在下一節中，您可以找到使用抽象 RPC 表示法的每個 API 操作的說明。每個操作都有一個操作名稱，此名稱不會顯示在線路上。每個操作的主題都會指定映射至 HTTP 請求元素。

指定請求所對應的特定 Amazon EFS 操作，取決於請求方法 (GET、PUT、POST 或 DELETE) 的組合，及其 Request-URI 所符合的各種模式。如果此操作為 PUT 或 POST，Amazon EFS 會從請求內文中的 Request-URI 路徑區段、查詢參數和 JSON 物件擷取呼叫引數。

**注意**  
雖然 等操作名稱`CreateFileSystem`不會出現在線路上，但這些名稱在 AWS Identity and Access Management (IAM) 政策中是有意義的。如需詳細資訊，請參閱[Amazon EFS 的身分和存取管理](security-iam.md)。  
此操作名稱亦用於命名命令列工具中的命令和 AWS SDK API 的元素。例如，有一個名為 `create-file-system` 的 AWS CLI 命令會映射到 `CreateFileSystem`操作。  
操作名稱也會出現在 Amazon EFS API 呼叫的 AWS CloudTrail 日誌中。

## API 端點
<a name="api-reference-endpoint"></a>

端點是做為 AWS Web 服務進入點的 URL。Amazon EFS 支援下列端點類型：
+ IPv4 端點
+ 雙堆疊 (IPv4 和 IPv6) 端點
+ [FIPS 端點](https://docs.aws.amazon.com/general/latest/gr/rande.html#FIPS-endpoints)

當您提出請求時，您可以指定要使用的端點。如果您沒有指定端點，則預設使用 IPv4 端點。若要使用不同的端點類型，您必須在請求中將其指定。如需如何執行此作業的範例，請參閱 [指定端點](#endpoints-specifying)。如需可用端點的資料表，請參閱 [Amazon EFS 端點和配額](https://docs.aws.amazon.com/general/latest/gr/elasticfilesystem.html)。

### IPv4 端點
<a name="ipv4-endpoints"></a>

IPv4 端點僅支援 IPv4 流量。IPv4 端點適用於所有區域。IPv4 端點的格式取決於 區域。
+ 對於 AWS 商業區域中的 IPv4 端點，格式為 `elasticfilesystem.{{region}}.amazonaws.com`。

  例如，如果您指定 `elasticfilesystem.us-west-2.amazonaws.com`做為端點，我們會將您的請求導向美國西部 （奧勒岡） 區域 (us-west-2) 端點。
+ 對於中國區域的 IPv4 端點，格式為 `elasticfilesystem.{{region}}.amazonaws.com.rproxy.govskope.us.cn`。

  例如，中國 （北京） 區域的 Amazon EFS API 端點為 `elasticfilesystem---cn-north-1.amazonaws.com.rproxy.govskope.us.cn`。

### 雙堆疊 (IPv4 和 IPv6) 端點
<a name="dualstack-endpoints"></a>

雙堆疊端點同時支援 IPv4 和 IPv6 流量。當您請求雙堆疊端點時，端點 URL 會解析為 IPv6 或 IPv4 地址，具體視您的網路和用戶端使用的通訊協定而異。雙堆疊端點的格式取決於 區域。
+ 對於 AWS 商業區域中的雙堆疊端點，格式為 `efs.{{aws-region}}.api.aws`。

  例如，美國西部 （奧勒岡） 區域 (us-west-2) 的雙堆疊端點為 `efs.eu-west-2.api.aws`。
+ 對於中國區域的雙堆疊端點，格式為 `efs.{{region}}.api.amazonwebservices.com.rproxy.govskope.us.cn`。

  例如，中國 （北京） 區域的雙堆疊端點為 `efs---cn-north-1---api.amazonwebservices.com.rproxy.govskope.us.cn`。

### 指定端點
<a name="endpoints-specifying"></a>

下列範例示範如何使用 AWS CLI 適用於 Amazon EFS 的 ，為美國西部 （加利佛尼亞北部） 區域 (us-west-1) 指定端點。

IPv4

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

雙堆疊

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

## API 版本
<a name="api-reference-version"></a>

要用於呼叫的 API 版本會以請求 URI 的第一個路徑區段來識別，且其形式為 ISO 8601 日期。如需範例，請參閱 [CreateFileSystem](API_CreateFileSystem.md)。

文件說明的是 API 2015-02-01 版。

## 相關主題
<a name="api-reference-related-topics"></a>

以下章節提供 API 操作的說明、如何建立用於請求身分驗證的簽章，以及如何使用 IAM 政策將許可授予給這些 API 操作。
+ [Amazon EFS 的身分和存取管理](security-iam.md)
+ [動作](API_Operations.md)
+ [資料類型](API_Types.md)

## 使用 Amazon EFS 的查詢 API 請求率
<a name="api-throttling"></a>

 AWS 帳戶 每個區域的 Amazon EFS API 請求都會受到調節，以協助服務效能。所有 Amazon EFS API 呼叫一起呼叫，無論是來自應用程式 AWS CLI、 或 Amazon EFS 主控台，都不得超過允許的 API 請求速率上限。最大 API 請求率可能因而異 AWS 區域。提出的 API 請求歸因於基礎 AWS 帳戶。

如果 API 請求超過其類別的 API 請求率，該請求將傳回 `ThrottlingException` 錯誤碼。若要避免發生這種錯誤，請確保您的應用程式不會過度頻繁地重試 API 請求。您可以謹慎使用輪詢以及使用指數退避重試，以避免此錯誤。

### 輪詢
<a name="efs-polling"></a>

您的應用程式可能需要重複呼叫 API 操作，以查看狀態的更新。在您開始輪詢前，請設定請求時間讓請求可能完成。當您開始輪詢時，請在連續的請求之間使用適當的休眠間隔。為了獲得最佳結果，請使用較長的休眠間隔。

### 重試或批次處理
<a name="efs-retries"></a>

您的應用程式可能需要在請求失敗之後重試 API 請求，或處理多個資源 (例如，所有 Amazon EFS 檔案系統)。若要降低 API 請求的速率，請在連續的請求之間使用適當的休眠間隔。為了獲得最佳結果，請使用較長或可變的休眠間隔。

### 計算休眠間隔
<a name="efs-sleep-interval-calculation"></a>

當您需要輪詢或重試 API 請求時，建議您使用指數退避演算法來計算 API 呼叫之間的休眠間隔。指數退避的背後概念是，對於連續錯誤回應，讓重試之間的等待時間漸進拉長。如需詳細資訊，以及此演算法的實作範例，請參閱《》中的[重試行為](https://docs.aws.amazon.com/general/latest/gr/api-retries.html)*Amazon Web Services 一般參考。*