本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
Amazon EFS API 是以 HTTP (RFC 2616)
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 的身分和存取管理。
此操作名稱亦用於命名命令列工具中的命令和 AWS SDK API 的元素。例如,有一個名為 create-file-system
的 AWS CLI 命令會映射到 CreateFileSystem
操作。
操作名稱也會出現在 Amazon EFS API 呼叫的 AWS CloudTrail 日誌中。
API 端點
API 端點是在 API 呼叫之 HTTP URI 中做為主機的 DNS 名稱。這些 API 端點專屬於 AWS 區域 ,並採用下列形式。
elasticfilesystem.
aws-region
.amazonaws.com
例如,美國西部 (奧勒岡) 的 Amazon EFS API 端點如下。
elasticfilesystem.us-west-2.amazonaws.com
如需 AWS 區域 Amazon EFS 支援的 清單 (您可以在其中建立和管理檔案系統),請參閱 中的 Amazon Elastic File SystemAWS 一般參考。
區域特定的 API 端點會定義您在發出 API 呼叫時可存取 Amazon EFS 資源範圍。例如,當您使用先前的端點呼叫 DescribeFileSystems
操作時,您會取得美國西部 (奧勒岡) 區域中已在您的帳戶中建立的檔案系統清單。
API 版本
要用於呼叫的 API 版本會以請求 URI 的第一個路徑區段來識別,且其形式為 ISO 8601 日期。如需範例,請參閱 CreateFileSystem。
文件說明的是 API 2015-02-01 版。
相關主題
以下章節提供 API 操作的說明、如何建立用於請求身分驗證的簽章,以及如何使用 IAM 政策將許可授予給這些 API 操作。
使用 Amazon EFS 的查詢 API 請求率
AWS 帳戶 每個區域的 Amazon EFS API 請求都會受到調節,以協助服務效能。所有 Amazon EFS API 呼叫一起呼叫,無論它們來自應用程式 AWS CLI、 或 Amazon EFS 主控台,都不得超過允許的 API 請求率上限。API 請求率上限可能有所不同 AWS 區域。提出的 API 請求歸因於基礎 AWS 帳戶。
如果 API 請求超過其類別的 API 請求率,該請求將傳回 ThrottlingException
錯誤碼。若要避免發生這種錯誤,請確保您的應用程式不會過度頻繁地重試 API 請求。您可以謹慎使用輪詢以及使用指數退避重試,以避免此錯誤。
輪詢
您的應用程式可能需要重複呼叫 API 操作,以查看狀態的更新。在您開始輪詢前,請設定請求時間讓請求可能完成。當您開始輪詢時,請在連續的請求之間使用適當的休眠間隔。為了獲得最佳結果,請使用較長的休眠間隔。
重試或批次處理
您的應用程式可能需要在請求失敗之後重試 API 請求,或處理多個資源 (例如,所有 Amazon EFS 檔案系統)。若要降低 API 請求的速率,請在連續的請求之間使用適當的休眠間隔。為了獲得最佳結果,請使用較長或可變的休眠間隔。
計算休眠間隔
當您需要輪詢或重試 API 請求時,建議您使用指數退避演算法來計算 API 呼叫之間的休眠間隔。指數退避的背後概念是,對於連續錯誤回應,讓重試之間的等待時間漸進拉長。如需此演算法的詳細資訊和實作範例,請參閱 AWS 中的Amazon Web Services 一般參考中的錯誤重試與指數退避。