DescribeFileSystems

ファイルシステム CreationToken またはファイルシステム FileSystemId のいずれかが提供された場合、特定の Amazon EFS ファイルシステムの説明を返します。それ以外の場合は、コール先のエンドポイントの AWS リージョン にある発信者の AWS アカウント が所有するすべてのファイルシステムの説明を返します。

すべてのファイルシステムの説明を取得する際に、オプションで MaxItems パラメータを指定して、応答に含まれる説明の数を制限することができます。この数値は自動的に 100 に設定されます。より多くのファイルシステムの説明が残っている場合、Amazon EFS は応答で不透明な トークンである NextMarker を返します。この場合、Marker リクエストのパラメーターを NextMarker の値に設定して、次のリクエストを送信する必要があります。

ファイルシステムの説明の一覧を取得するために、このオペレーションは反復プロセスで使用されます。ここでは、DescribeFileSystems が Marker なしで最初にコールされ、Marker パラメータが前の応答の NextMarker の値に設定された状態で、応答に NextMarker がなくなるまで、オペレーションはコールし続けます。

1回の DescribeFileSystems コールの応答で返されるファイルシステムの順序と、複数回コールの反復の応答全体で返されるファイルシステムの順序は、指定されていません。

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

リクエストの構文

GET /2015-02-01/file-systems?CreationToken=CreationToken&FileSystemId=FileSystemId&Marker=Marker&MaxItems=MaxItems HTTP/1.1

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

リクエスト本文

リクエストにリクエスト本文がありません。

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "FileSystems": [ 
      { 
         "AvailabilityZoneId": "string",
         "AvailabilityZoneName": "string",
         "CreationTime": number,
         "CreationToken": "string",
         "Encrypted": boolean,
         "FileSystemArn": "string",
         "FileSystemId": "string",
         "FileSystemProtection": { 
            "ReplicationOverwriteProtection": "string"
         },
         "KmsKeyId": "string",
         "LifeCycleState": "string",
         "Name": "string",
         "NumberOfMountTargets": number,
         "OwnerId": "string",
         "PerformanceMode": "string",
         "ProvisionedThroughputInMibps": number,
         "SizeInBytes": { 
            "Timestamp": number,
            "Value": number,
            "ValueInArchive": number,
            "ValueInIA": number,
            "ValueInStandard": number
         },
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "ThroughputMode": "string"
      }
   ],
   "Marker": "string",
   "NextMarker": "string"
}

レスポンス要素

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

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

エラー

例

10 個のファイルシステムのリストの取得

次の例では、GET リクエストを file-systems エンドポイント (elasticfilesystem.us-west-2.amazonaws.com/2015-02-01/file-systems)に送信します。このリクエストでは、MaxItems クエリ パラメータを指定して、ファイルシステムの説明の数を 10 に制限します。

リクエスト例

GET /2015-02-01/file-systems?MaxItems=10 HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140622T191208Z
Authorization: <...>

レスポンス例

HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 499
{
   "FileSystems":[
      {
         "OwnerId":"251839141158",
         "CreationToken":"MyFileSystem1",
         "FileSystemId":"fs-01234567",
         "PerformanceMode" : "generalPurpose",
         "CreationTime":"1403301078",
         "LifeCycleState":"created",
         "Name":"my first file system",
         "NumberOfMountTargets":1,
         "SizeInBytes":{
            "Timestamp": 1403301078,
            "Value": 29313618372,
            "ValueInArchive": 201156,
            "ValueInIA": 675432,
            "ValueInStandard": 29312741784
         }
      }
   ]
}

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

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