翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ListClusterSnapshots
指定された Elastic クラスターのスナップショットに関する情報を返します。
リクエストの構文
GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- clusterArn
-
エラスティッククラスターの ARN 識別子。
- maxResults
-
レスポンスで受け取るエラスティッククラスタースナップショット結果の最大数。
有効範囲: 最小値 は 20 です。最大値は 100 です。
- nextToken
-
以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、
max-resultsで指定された値までのレコードが含まれます。レスポンスにデータがなくなると、
nextTokenは返されません。 - snapshotType
-
返されるクラスタースナップショットのタイプ。次のいずれかの値を指定できます。
-
automated- Amazon DocumentDB が AWS アカウントに対して自動的に作成したすべてのクラスタースナップショットを返します。 -
manual- AWS アカウント用に手動で作成したすべてのクラスタースナップショットを返します。
-
リクエスト本文
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"snapshots": [
{
"clusterArn": "string",
"snapshotArn": "string",
"snapshotCreationTime": "string",
"snapshotName": "string",
"status": "string"
}
]
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- nextToken
-
以前のリクエストで提供されたページ分割トークン。このパラメータが指定されている場合、レスポンスにはこのトークンより大きく、
max-resultsで指定された値までのレコードが含まれます。レスポンスにデータがなくなると、
nextTokenは返されません。型: 文字列
- snapshots
-
指定した Elastic クラスターのスナップショットのリスト。
型: ClusterSnapshotInList オブジェクトの配列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
アクションを実行するための十分なアクセス許可がない場合に発生する例外。
HTTP ステータスコード: 403
- InternalServerException
-
内部サーバーエラーが発生しました。
HTTP ステータスコード：500
- ThrottlingException
-
ThrottlingException は、リクエストのスロットリングによりリクエストが拒否されたときにスローされます。
HTTP ステータスコード: 429
- ValidationException
-
検証例外の定義がある構造。
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
