

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# DescribeFileSystems
<a name="API_DescribeFileSystems"></a>

如果提供了檔案系統 `CreationToken` 或 `FileSystemId`，則傳回特定 Amazon EFS 檔案系統的說明。否則，它會在您呼叫的 AWS 區域 端點的 AWS 帳戶 中，傳回呼叫者 擁有的所有檔案系統的描述。

擷取所有檔案系統描述時，您可以選擇性地指定 `MaxItems` 參數，以限制回應中的描述數目。此數字會自動設定為 100。如果要保留更多檔案系統描述，Amazon EFS 會在回應中傳回 `NextMarker` (不透明權杖)。在這種情況下，您應該使用 `Marker` 請求參數 (設定為 `NextMarker` 的值) 傳送後續請求。

若要擷取檔案系統描述清單，則要在反覆程序中使用如下操作，即先呼叫 `DescribeFileSystems` 而不包含 `Marker`，然後使用 `Marker` 參數繼續呼叫，直至沒有 `NextMarker` 回應爲止。其中，參數設定為先前回應的 `NextMarker` 值。

 未指定一次 `DescribeFileSystems` 呼叫回應中傳回的檔案系統順序，也未指定跨多路呼叫重複回應傳回的檔案系統順序。

 這項操作需要 `elasticfilesystem:DescribeFileSystems` 動作的許可。

## 請求語法
<a name="API_DescribeFileSystems_RequestSyntax"></a>

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

## URI 請求參數
<a name="API_DescribeFileSystems_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [CreationToken](#API_DescribeFileSystems_RequestSyntax) **   <a name="efs-DescribeFileSystems-request-uri-CreationToken"></a>
(可選) 使用此建立權杖 (字串) 將列表限制為檔案系統。建立 Amazon EFS 檔案系統時，您要指定建立權杖。  
長度限制：長度下限為 1。長度上限為 64。  
模式：`.+`

 ** [FileSystemId](#API_DescribeFileSystems_RequestSyntax) **   <a name="efs-DescribeFileSystems-request-uri-FileSystemId"></a>
(選用) 您要擷取其說明的檔案系統 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](#API_DescribeFileSystems_RequestSyntax) **   <a name="efs-DescribeFileSystems-request-uri-Marker"></a>
(選用) 從先前的 `DescribeFileSystems` 操作中傳回不透明分頁權杖 (字串)。如果存在，則指定從傳回呼叫中斷的地方繼續列表。  
長度限制：長度下限為 1。長度上限為 128。  
模式：`.+`

 ** [MaxItems](#API_DescribeFileSystems_RequestSyntax) **   <a name="efs-DescribeFileSystems-request-uri-MaxItems"></a>
(選用) 指定回應中傳回的檔案系統數量上限。此數字會自動設定為 100。如果您有 100 多個檔案系統，那麽回應會以每頁 100 進行分頁。  
有效範圍：最小值為 1。

## 請求主體
<a name="API_DescribeFileSystems_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_DescribeFileSystems_ResponseSyntax"></a>

```
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"
}
```

## 回應元素
<a name="API_DescribeFileSystems_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [FileSystems](#API_DescribeFileSystems_ResponseSyntax) **   <a name="efs-DescribeFileSystems-response-FileSystems"></a>
檔案系統描述陣列。  
類型：[FileSystemDescription](API_FileSystemDescription.md) 物件陣列

 ** [Marker](#API_DescribeFileSystems_ResponseSyntax) **   <a name="efs-DescribeFileSystems-response-Marker"></a>
如果在請求中由發起人提供了相應的信息 (字串)，那麼這個信息就會在響應中呈現。  
類型：字串  
長度限制：長度下限為 1。長度上限為 128。  
模式：`.+`

 ** [NextMarker](#API_DescribeFileSystems_ResponseSyntax) **   <a name="efs-DescribeFileSystems-response-NextMarker"></a>
如果在回應中傳回的文件系統數量少於所有存在的文件系統，那麼相應的信息 (字串)就會在響應中呈現。您可以在後續請求中使用 `NextMarker` 來擷取下一頁描述。  
類型：字串  
長度限制：長度下限為 1。長度上限為 128。  
模式：`.+`

## 錯誤
<a name="API_DescribeFileSystems_Errors"></a>

 ** BadRequest **   
如果請求格式錯誤或包含錯誤，例如無效的參數值或缺少必要參數，則傳回。    
 ** ErrorCode **   
錯誤代碼是一個字串，專門用於識別錯誤狀況。偵測及依類型處理錯誤的程式必須讀取及了解此代碼。  
 ** Message **   
錯誤訊息包含錯誤狀況的一般英文描述，目標對象是人。一般簡單的程式在發生其無法處理的錯誤狀況時，會直接對最終使用者顯示訊息。複雜一些的程式因為錯誤處理更加周密，而且經過適當的國際化，所以很可能會忽略錯誤訊息。
HTTP 狀態碼：400

 ** FileSystemNotFound **   
如果指定的`FileSystemId`值不存在於請求者的 中，則傳回 AWS 帳戶。    
 ** ErrorCode **   
錯誤代碼是一個字串，專門用於識別錯誤狀況。偵測及依類型處理錯誤的程式必須讀取及了解此代碼。  
 ** Message **   
錯誤訊息包含錯誤狀況的一般英文描述，目標對象是人。一般簡單的程式在發生其無法處理的錯誤狀況時，會直接對最終使用者顯示訊息。複雜一些的程式因為錯誤處理更加周密，而且經過適當的國際化，所以很可能會忽略錯誤訊息。
HTTP 狀態碼：404

 ** InternalServerError **   
如果伺服器端發生錯誤，則傳回。    
 ** ErrorCode **   
錯誤代碼是一個字串，專門用於識別錯誤狀況。偵測及依類型處理錯誤的程式必須讀取及了解此代碼。  
 ** Message **   
錯誤訊息包含錯誤狀況的一般英文描述，目標對象是人。一般簡單的程式在發生其無法處理的錯誤狀況時，會直接對最終使用者顯示訊息。複雜一些的程式因為錯誤處理更加周密，而且經過適當的國際化，所以很可能會忽略錯誤訊息。
HTTP 狀態碼：500

## 範例
<a name="API_DescribeFileSystems_Examples"></a>

### 擷取 10 個檔案系統清單
<a name="API_DescribeFileSystems_Example_1"></a>

 下列範例會將 GET 請求傳送至 `file-systems` 端點 (`elasticfilesystem.us-west-2.amazonaws.com/2015-02-01/file-systems`)。請求會指定 `MaxItems` 查詢參數，以便將檔案系統描述的數目限制為 10。

#### 請求範例
<a name="API_DescribeFileSystems_Example_1_Request"></a>

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

#### 回應範例
<a name="API_DescribeFileSystems_Example_1_Response"></a>

```
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
         }
      }
   ]
}
```

## 另請參閱
<a name="API_DescribeFileSystems_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeFileSystems) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeFileSystems) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeFileSystems) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeFileSystems) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeFileSystems) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeFileSystems) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeFileSystems) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeFileSystems) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeFileSystems) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeFileSystems) 