翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeFileSystems
EFS ファイルシステムCreationTokenまたは FileSystemIdが指定されている場合、特定の Amazon ファイルシステムの説明を返します。それ以外の場合は、呼び出し先の AWS リージョン エンドポイントの AWS アカウント で呼び出し元の が所有するすべてのファイルシステムの説明を返します。
すべてのファイルシステムの説明を取得する際に、オプションで MaxItems パラメータを指定して、応答に含まれる説明の数を制限することができます。この数値は自動的に 100 に設定されます。さらに多くのファイルシステムの説明が残っている場合、Amazon はレスポンスで不透明なトークンNextMarkerである EFSを返します。この場合、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パラメータを使用します。
- CreationToken
-
(オプション) リストを、この作成トークン(文字列)を持つファイルシステムに制限します。Amazon EFS ファイルシステムを作成するときに、作成トークンを指定します。
長さの制限：最小長は 1 です。最大長は 64 文字です。
パターン:
.+ - FileSystemId
-
（オプション）説明を取得するファイルシステムの ID（文字列）。
長さの制限：最大長は 128 です。
パターン：
^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$ - Marker
-
(オプション) 前の
DescribeFileSystemsオペレーション (文字列)から返された不透明なページ割りトークン。存在する場合は、返すコールが中断された場所からリストを続行するように指定します。長さの制限：最小長は 1 です。最大長は 128 です。
パターン:
.+ - MaxItems
-
（オプション）レスポンスで返すファイルシステムの最大数を指定します（整数）。この数値は自動的に 100 に設定されます。100 を超えるファイルシステムがある場合、応答はページあたり 100 でページ割りされます。
有効な範囲: 最小値 は 1 です。
リクエスト本文
リクエストにリクエスト本文がありません。
レスポンスの構文
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"
}レスポンス要素
アクションが成功すると、サービスは 200 HTTP レスポンスを返します。
次のデータは、 サービスによって JSON 形式で返されます。
- FileSystems
-
ファイルシステムの説明の配列。
型: FileSystemDescription オブジェクトの配列
- Marker
-
リクエストで発信者から提供された場合に存在します (文字列)。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン:
.+ - NextMarker
-
応答で返されたファイルシステムよりも多くのファイルシステムがある場合に表示されます (文字列)。後続のリクエストで
NextMarkerを使うと、説明をフェッチすることができます。型: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン：
.+
エラー
- BadRequest
-
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
HTTP ステータスコード: 400
- FileSystemNotFound
-
指定された
FileSystemId値がリクエスタの に存在しない場合に返されます AWS アカウント。HTTP ステータスコード: 404
- InternalServerError
-
サーバー側でエラーが発生した場合に返されます。
HTTP ステータスコード: 500
例
10 個のファイルシステムのリストの取得
次の例では、file-systemsエンドポイント () にGETリクエストを送信します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
}
}
]
}以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。
