CreateAccessPoint - Amazon Elastic File System
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラー以下も参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateAccessPoint

EFS アクセスポイントの作成 アクセスポイントは、EFS ファイルシステムに対するアプリケーション固有のビューで、オペレーティングシステムのユーザーとグループ、およびファイルシステムパスを、アクセスポイントを介して行われたすべてのファイルシステムリクエストに適用されます。オペレーティングシステムのユーザーおよびグループは、NFS クライアントから提供されるすべての アイデンティティ 情報を上書きします。ファイルシステムのパスは、アクセスポイントのルートディレクトリとしてクライアントに公開されます。アクセスポイントを使用するアプリケーションは、アプリケーション自体のディレクトリとサブディレクトリ内のデータにのみアクセスできます。詳細はこちら、「EFS アクセスポイントを使用してファイルシステムをマウントする」を参照してください。

注記

同じファイルシステムにアクセスポイントを作成する複数のリクエストが連続して送信され、そのファイルシステムが 1,000 アクセスポイントの制限に近い場合、これらのリクエストに対するスロットリングレスポンスが調整される場合があります。これは、ファイルシステムが指定されたアクセスポイントの制限を超えないようにするためです。

このオペレーションには、elasticfilesystem:CreateAccessPoint アクションに対するアクセス許可が必要です。

アクセスポイントは作成時にタグ付けをすることができます。作成アクションでタグが指定されている場合、IAM は elasticfilesystem:TagResource アクションに対して追加の認可を実行して、ユーザーがタグを作成する認可を持っているかどうかを確認します。したがって、elasticfilesystem:TagResource アクションを使用するための明示的なアクセス許可を付与する必要があります。詳細については、「リソース作成時にタグ付けするアクセス許可の付与」を参照してください。

リクエストの構文

POST /2015-02-01/access-points HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "FileSystemId": "string",
   "PosixUser": { 
      "Gid": number,
      "SecondaryGids": [ number ],
      "Uid": number
   },
   "RootDirectory": { 
      "CreationInfo": { 
         "OwnerGid": number,
         "OwnerUid": number,
         "Permissions": "string"
      },
      "Path": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

ClientToken

べき等の作成を保証するために Amazon EFS が使用する最大 64 の ASCII 文字の文字列。

型: 文字列

長さの制限：最小長は 1 です。最大長は 64 文字です。

パターン: .+

必須：はい

FileSystemId

アクセスポイントがアクセスを提供する EFS ファイルシステムの ID。

型: 文字列

長さの制限：最大長は 128 です。

パターン：^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$

必須：はい

PosixUser

アクセスポイントを使用して行われたすべてのファイル システムリクエストに適用されたオペレーティングシステムのユーザーおよびグループ。

型: PosixUser オブジェクト

必須: いいえ

RootDirectory

アクセスポイントを使用する NFS クライアントに対して、アクセスポイントがファイルシステムのルートディレクトリとして公開する EFS ファイルシステム上のディレクトリを指定します。アクセスポイントを使用するクライアントは、ルートディレクトリ以下にのみアクセスできます。指定した RootDirectory > Path が存在しない場合、Amazon EFS はそれを作成し、クライアントがアクセスポイントに接続する際に CreationInfo 設定を適用します。RootDirectory を指定する際には、Path、CreationInfo を指定する必要があります。

Amazon EFS は、ディレクトリに CreationInfo： OwnUid、OwnGID、および アクセス許可を指定した場合にのみルートディレクトリを作成します。この情報を指定しない場合、Amazon EFS はルートディレクトリを作成しません。ルートディレクトリが存在しない場合に、アクセスポイントを使用してマウントしようとすると、失敗します。

型: RootDirectory オブジェクト

必須: いいえ

Tags

アクセスポイントに関連付けられたタグを作成します。各タグはキーバリューのペアです。各キーは一意である必要があります。詳細については、「 AWS 全般のリファレンスガイド」の「 AWS リソースのタグ付け」を参照してください。

型: Tag オブジェクトの配列

必須: いいえ

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "AccessPointArn": "string",
   "AccessPointId": "string",
   "ClientToken": "string",
   "FileSystemId": "string",
   "LifeCycleState": "string",
   "Name": "string",
   "OwnerId": "string",
   "PosixUser": { 
      "Gid": number,
      "SecondaryGids": [ number ],
      "Uid": number
   },
   "RootDirectory": { 
      "CreationInfo": { 
         "OwnerGid": number,
         "OwnerUid": number,
         "Permissions": "string"
      },
      "Path": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

AccessPointArn

アクセスポイントに関連付けられた一意の Amazon リソースネーム (ARN)。

型: 文字列

長さの制限：最大長は 128 です。

パターン：^arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}$

AccessPointId

Amazon EFS によって割り当てられたアクセスポイントの ID。

型: 文字列

長さの制限：最大長は 128 です。

パターン：^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$

ClientToken

冪等性の作成を保証するためにリクエストで指定された不透明な文字列。

型: 文字列

長さの制限：最小長は 1 です。最大長は 64 文字です。

パターン: .+

FileSystemId

アクセスポイントが適用される EFS ファイルシステムの ID。

型: 文字列

長さの制限：最大長は 128 です。

パターン：^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$

LifeCycleState

アクセスポイントのライフサイクルフェーズを識別します。

型: 文字列

有効な値：creating | available | updating | deleting | deleted | error

Name

このアクセスポイントの名前。これは、Name タグの値です。

型: 文字列

OwnerId

アクセスポイントリソースを所有 AWS アカウント する を識別します。

型: 文字列

長さの制限: 最大長は 14 です。

Pattern: ^(\d{12})|(\d{4}-\d{4}-\d{4})$

PosixUser

アクセスポイント上の、ユーザー ID、グループ ID、およびセカンダリグループ ID を含む完全な POSIX アイデンティティ。アクセスポイントを使用する NFS クライアントによるすべてのファイル オペレーションに使用されます。

型: PosixUser オブジェクト

RootDirectory

アクセスポイントを使用して、アクセスポイントが NFS クライアントにルートディレクトリとして公開する EFS ファイルシステム上のディレクトリ。

型: RootDirectory オブジェクト

Tags

タグオブジェクトの配列として表示される、アクセスポイントに関連付けられたタグ。

型: Tag オブジェクトの配列

エラー

AccessPointAlreadyExists

作成しようとしているアクセスポイントがすでに存在し、リクエストで指定した作成 トークンとともに返されます。

HTTP ステータスコード: 409

AccessPointLimitExceeded

AWS アカウント がファイルシステムごとに許可されるアクセスポイントの最大数を既に作成している場合に返されます。詳細については、「https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region」を参照してください。

HTTP ステータスコード: 403

BadRequest

リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータがないなどのエラーが含まれている場合に返されます。

HTTP ステータスコード：400

FileSystemNotFound

指定されたFileSystemId値がリクエスタの に存在しない場合に返されます AWS アカウント。

HTTP ステータスコード: 404

IncorrectFileSystemLifeCycleState

ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。

HTTP ステータスコード: 409

InternalServerError

サーバー側でエラーが発生した場合に返されます。

HTTP ステータスコード：500

ThrottlingException

CreateAccessPoint API アクションの呼び出しが速すぎて、ファイルシステム上のアクセスポイントの数が 120 の制限に近づいた場合に返されます。

HTTP ステータスコード: 429

以下も参照してください。

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。