

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

# ListRegions
<a name="API_ListRegions"></a>

列出指定帳戶的所有區域及其個別選擇加入狀態。或者，可以依 `region-opt-status-contains` 參數篩選此清單。

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

```
POST /listRegions HTTP/1.1
Content-type: application/json

{
   "AccountId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "RegionOptStatusContains": [ "string" ]
}
```

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

請求不會使用任何 URI 參數。

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

請求接受採用 JSON 格式的下列資料。

 ** [AccountId](#API_ListRegions_RequestSyntax) **   <a name="accounts-ListRegions-request-AccountId"></a>
指定您要透過此操作存取或修改之 AWS 帳戶 的 12 位數帳戶 ID 號碼。如果您未指定此參數，它會預設為用於呼叫 操作之身分的 Amazon Web Services 帳戶。若要使用此參數，發起人必須是[組織管理帳戶](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account)或委派管理員帳戶中的身分。指定的帳戶 ID 必須是相同組織中的成員帳戶。組織必須[啟用所有功能](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html)，且組織必須針對帳戶管理服務啟用[受信任存取](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html)，並選擇性地指派[委派的管理員](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#delegated-admin)帳戶。  
管理帳戶無法指定自己的 `AccountId`。它必須藉由不包含 `AccountId` 參數，在獨立內容中呼叫 操作。
若要在非組織成員的帳戶上呼叫此操作，請勿指定此參數。反之，使用屬於您想要擷取或修改其聯絡人之帳戶的身分來呼叫 操作。  
類型：字串  
模式：`\d{12}`  
必要：否

 ** [MaxResults](#API_ListRegions_RequestSyntax) **   <a name="accounts-ListRegions-request-MaxResults"></a>
命令輸出中要傳回的項目總數。如果可用的項目總數超過指定的值，`NextToken`則會在命令的輸出中提供 。若要繼續分頁，請在後續命令的 `starting-token` 引數中提供 `NextToken` 值。請勿在 CLI AWS 外部直接使用`NextToken`回應元素。如需使用範例，請參閱《 * AWS 命令列界面使用者指南*》中的[分頁](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html)。  
類型：整數  
有效範圍：最小值為 1。最大值為 50。  
必要：否

 ** [NextToken](#API_ListRegions_RequestSyntax) **   <a name="accounts-ListRegions-request-NextToken"></a>
用於指定開始分頁位置的字符。這是先前截斷的回應`NextToken`中的 。如需使用範例，請參閱《 * AWS 命令列界面使用者指南*》中的[分頁](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html)。  
類型：字串  
長度限制：長度下限為 0。長度上限為 1000。  
必要：否

 ** [RegionOptStatusContains](#API_ListRegions_RequestSyntax) **   <a name="accounts-ListRegions-request-RegionOptStatusContains"></a>
區域狀態清單 （啟用、啟用、停用、停用、啟用、by\$1default)，可用來篩選指定帳戶的區域清單。例如，傳入 ENABLING 值只會傳回區域狀態為 ENABLING 的區域清單。  
類型：字串陣列  
有效值:`ENABLED | ENABLING | DISABLING | DISABLED | ENABLED_BY_DEFAULT`   
必要：否

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

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Regions": [ 
      { 
         "RegionName": "string",
         "RegionOptStatus": "string"
      }
   ]
}
```

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

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

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

 ** [NextToken](#API_ListRegions_ResponseSyntax) **   <a name="accounts-ListRegions-response-NextToken"></a>
如果要傳回更多資料，則會填入此項目。它應該傳遞到 的`next-token`請求參數`list-regions`。  
類型：字串

 ** [Regions](#API_ListRegions_ResponseSyntax) **   <a name="accounts-ListRegions-response-Regions"></a>
這是指定帳戶的 區域清單，或者如果使用篩選過的參數，則為符合 `filter` 參數中所設定篩選條件的區域清單。  
類型：[Region](API_Region.md) 物件陣列

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

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** AccessDeniedException **   
操作失敗，因為呼叫身分沒有所需的最低許可。    
 ** errorType **   
由 API Gateway 填入`x-amzn-ErrorType`回應標頭的值。
HTTP 狀態碼：403

 ** InternalServerException **   
由於 內部發生錯誤，操作失敗 AWS。請稍後重試您的操作。    
 ** errorType **   
由 API Gateway 填入`x-amzn-ErrorType`回應標頭的值。
HTTP 狀態碼：500

 ** TooManyRequestsException **   
操作失敗，因為呼叫次數太頻繁且超過節流限制。    
 ** errorType **   
由 API Gateway 填入`x-amzn-ErrorType`回應標頭的值。
HTTP 狀態碼：429

 ** ValidationException **   
操作失敗，因為其中一個輸入參數無效。    
 ** fieldList **   
偵測到無效項目的欄位。  
 ** message **   
通知您有關請求無效內容的訊息。  
 ** reason **   
驗證失敗的原因。
HTTP 狀態碼：400

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

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