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

# ListClusterSnapshots
<a name="API_elastic_ListClusterSnapshots"></a>

指定された Elastic クラスターのスナップショットに関する情報を返します。

## リクエストの構文
<a name="API_elastic_ListClusterSnapshots_RequestSyntax"></a>

```
GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1
```

## URI リクエストパラメータ
<a name="API_elastic_ListClusterSnapshots_RequestParameters"></a>

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

 ** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-clusterArn"></a>
エラスティッククラスターの ARN 識別子。

 ** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-maxResults"></a>
レスポンスで受け取るエラスティッククラスタースナップショット結果の最大数。  
有効範囲: 最小値 は 20 です。最大値は 100 です。

 ** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-nextToken"></a>
以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、`max-results` で指定された値までのレコードが含まれます。  
レスポンスにデータがなくなると、`nextToken` は返されません。

 ** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-request-uri-snapshotType"></a>
返されるクラスタースナップショットのタイプ。次のいずれかの値を指定できます。  
+  `automated` - Amazon DocumentDB が AWS アカウントに対して自動的に作成したすべてのクラスタースナップショットを返します。
+  `manual` - AWS アカウント用に手動で作成したすべてのクラスタースナップショットを返します。

## リクエスト本文
<a name="API_elastic_ListClusterSnapshots_RequestBody"></a>

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

## レスポンスの構文
<a name="API_elastic_ListClusterSnapshots_ResponseSyntax"></a>

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

{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "clusterArn": "string",
         "snapshotArn": "string",
         "snapshotCreationTime": "string",
         "snapshotName": "string",
         "status": "string"
      }
   ]
}
```

## レスポンス要素
<a name="API_elastic_ListClusterSnapshots_ResponseElements"></a>

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

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

 ** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-nextToken"></a>
以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、`max-results` で指定された値までのレコードが含まれます。  
レスポンスにデータがなくなると、`nextToken` は返されません。  
タイプ: 文字列

 ** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **   <a name="documentdb-elastic_ListClusterSnapshots-response-snapshots"></a>
指定した Elastic クラスターのスナップショットのリスト。  
型: [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md) オブジェクトの配列

## エラー
<a name="API_elastic_ListClusterSnapshots_Errors"></a>

すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。

 ** AccessDeniedException **   
アクションを実行するための十分なアクセス許可がない場合に発生する例外。    
 ** message **   
アクセスが拒否された理由を説明するエラーメッセージ。
HTTP ステータスコード: 403

 ** InternalServerException **   
内部サーバーエラーが発生しました。  
HTTP ステータスコード: 500

 ** ThrottlingException **   
ThrottlingException は、リクエストのスロットリングによりリクエストが拒否された場合にスローされます。    
 ** retryAfterSeconds **   
オペレーションを再試行する前に待つ秒数。
HTTP ステータスコード: 429

 ** ValidationException **   
検証例外の定義がある構造。    
 ** fieldList **   
検証例外が発生したフィールドのリスト。  
 ** message **   
検証例外を説明するエラーメッセージ。  
 ** reason **   
検証例外が発生した理由 (`unknownOperation`、`cannotParse`、`fieldValidationFailed`、または `other` のいずれか)。
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_elastic_ListClusterSnapshots_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots)