翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Amazon EFS API
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 の要素にも使用されます。たとえば、 CreateFileSystemオペレーションにマッピングcreate-file-systemされる という名前の AWS CLI コマンドがあります。
オペレーション名は、Amazon EFS API コールの AWS CloudTrail ログにも表示されます。
API エンドポイント
エンドポイントは、 AWS ウェブサービスのエントリポイントとして機能する URL です。Amazon EFS は、次のエンドポイントタイプをサポートしています。
-
IPv4 エンドポイント
-
デュアルスタック (IPv4 と IPv6 の両方) エンドポイント
リクエストを行うと、使用するエンドポイントを指定できます。エンドポイントを指定しない場合、デフォルトで IPv4 エンドポイントが使用されます。別のエンドポイントタイプを使用するには、リクエストで指定する必要があります。これを行う方法の例については、「エンドポイントの指定」を参照してください。使用可能なエンドポイントの表については、「Amazon EFS エンドポイントとクォータ」を参照してください。
IPv4 エンドポイント
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.ca.cnたとえば、中国 (北京) リージョンの Amazon EFS API エンドポイントは です
elasticfilesystem---cn-north-1.amazonaws.com.rproxy.govskope.ca.cn。
デュアルスタック (IPv4 および IPv6) エンドポイント
デュアルスタックエンドポイントは、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.ca.cnたとえば、中国 (北京) リージョンのデュアルスタックエンドポイントは です
efs---cn-north-1---api.amazonwebservices.com.rproxy.govskope.ca.cn。
エンドポイントの指定
次の例は、Amazon EFS の を使用して米国西部 (北カリフォルニア) リージョン (us-west-1) AWS CLI のエンドポイントを指定する方法を示しています。
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 バージョン
コールに使用される API のバージョンは、リクエスト URI の最初のパスセグメントにより特定されます。この形式は ISO 8601 の日付になります。例については、「CreateFileSystem」を参照してください。
ドキュメントでは、API バージョン 2015-02-01 について説明されています。
関連トピック
以下のセクションでは、API オペレーション、認証リクエスト用の署名を作成する方法、IAM ポリシーを使用して、これらの API オペレーションのためのアクセス許可を付与する方法を説明します。
Amazon EFS のクエリ API リクエスト率の使用
Amazon EFS API リクエストは AWS アカウント 、サービスのパフォーマンスを向上させるために、リージョンごとに ごとにスロットリングされます。すべての Amazon EFS API コールは、アプリケーション、、 AWS CLI Amazon EFS コンソールのいずれからのものであっても、許可される API リクエストの最大レートを超えることはできません。API リクエストの最大レートはさまざまです AWS リージョン。行われた API リクエストは、基盤となる に属性付けられます AWS アカウント。
API リクエストがそのカテゴリの API リクエスト率を超過する場合、ThrottlingException エラーコードが返されます。このエラーを回避するには、アプリケーションが API リクエストを再試行する率を低くします。これは、ポーリングの際に注意深くし、エクスポネンシャルバックオフの再試行を使用することにより行えます。
ポーリング
アプリケーションにより API オペレーションを繰り返しコールして、ステータスの更新をチェックする必要がある場合があります。ポーリングを開始する前に、リクエストの予想完了時間を指定します。ポーリングを開始するとき、連続するリクエストの間に適切なスリープ間隔を使用します。最良の結果を得るには、漸増スリープ間隔を使用します。
再試行またはバッチ処理
アプリケーションは、API リクエストが失敗した後に再試行するか、複数のリソースを処理する必要がある場合があります (たとえば、Amazon EFS ファイルシステムすべて)。API リクエストの率を下げるには、連続するリクエストの間に適切なスリープ間隔を使用します。最良の結果を得るには、漸増または可変スリープ間隔を使用します。
スリープ間隔の計算
API リクエストをポーリングまたは再試行する必要がある場合は、エクスポネンシャルバックオフ アルゴリズムを使用して API コール間のスリープ間隔を計算することをお勧めします。エクスポネンシャルバックオフの背後にある考え方は、連続したエラー応答の再試行間の待機時間を徐々に長く使用することです。このアルゴリズムの詳細と実装例については、の「再試行動作」を参照してくださいAmazon Web Services 全般のリファレンス。
