翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeSnapshots
クラスタースナップショットに関する情報を返します。デフォルトでは、 はすべてのスナップショットを DescribeSnapshots 一覧表示します。オプションで 1 つのスナップショットを記述することも、特定のクラスターに関連付けられたスナップショットのみを記述することもできます。
リクエストの構文
{
"ClusterName": "string",
"MaxResults": number,
"NextToken": "string",
"ShowDetail": boolean,
"SnapshotName": "string",
"Source": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- ClusterName
-
ユーザーが指定したクラスター識別子。このパラメータを指定した場合、その特定のクラスターに関連するスナップショットのみ表示されます。
タイプ: 文字列
必須: いいえ
- MaxResults
-
レスポンスに含めるレコードの最大数。指定された MaxResults 値よりも多くのレコードが存在する場合、残りの結果を取得できるようにトークンがレスポンスに含まれます。
タイプ: 整数
必須: いいえ
- NextToken
-
レコードの合計数が の値を超えた場合に渡すオプションの引数 MaxResults。nextToken が返された場合は、さらに結果があります。nextToken の値は、各ページに固有のページ分割トークンです。後続ページを取得するには、返されたトークンを使用して再度呼び出します。他の引数をすべて維持します。
タイプ: 文字列
必須: いいえ
- ShowDetail
-
ブール値が true の場合、シャード設定はスナップショットの説明に含まれます。
型: ブール値
必須: いいえ
- SnapshotName
-
ユーザーが指定するスナップショットの名前。このパラメータを指定した場合、この名前付きスナップショットのみを表示されます。
タイプ: 文字列
必須: いいえ
- Source
-
system に設定すると、出力には MemoryDB によって自動的に作成されたスナップショットが表示されます。user に設定すると、出力には手動で作成されたスナップショットが表示されます。省略すると、出力には、自動生成と手動作成、両方のスナップショットが表示されます。
タイプ: 文字列
必須: いいえ
レスポンスの構文
{
"NextToken": "string",
"Snapshots": [
{
"ARN": "string",
"ClusterConfiguration": {
"Description": "string",
"EngineVersion": "string",
"MaintenanceWindow": "string",
"Name": "string",
"NodeType": "string",
"NumShards": number,
"ParameterGroupName": "string",
"Port": number,
"Shards": [
{
"Configuration": {
"ReplicaCount": number,
"Slots": "string"
},
"Name": "string",
"Size": "string",
"SnapshotCreationTime": number
}
],
"SnapshotRetentionLimit": number,
"SnapshotWindow": "string",
"SubnetGroupName": "string",
"TopicArn": "string",
"VpcId": "string"
},
"DataTiering": "string",
"KmsKeyId": "string",
"Name": "string",
"Source": "string",
"Status": "string"
}
]
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
エラー
すべてのアクションに共通のエラーについては、共通エラー を参照してください。
- InvalidParameterCombinationException
-
HTTP ステータスコード：400
- InvalidParameterValueException
-
HTTP ステータスコード：400
- ServiceLinkedRoleNotFoundFault
-
HTTP ステータスコード：400
- SnapshotNotFoundFault
-
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
