DescribeSnapshots - Amazon MemoryDB

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

DescribeSnapshots

Mengembalikan informasi tentang snapshot klaster. Secara default, DescribeSnapshots daftar semua snapshot Anda; secara opsional dapat menggambarkan satu snapshot, atau hanya snapshot yang terkait dengan cluster tertentu.

Sintaksis Permintaan

{ "ClusterName": "string", "MaxResults": number, "NextToken": "string", "ShowDetail": boolean, "SnapshotName": "string", "Source": "string" }

Parameter Permintaan

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

Permintaan menerima data berikut dalam JSON format.

ClusterName

Pengidentifikasi cluster yang disediakan pengguna. Jika parameter ini ditentukan, hanya snapshot yang terkait dengan cluster tertentu yang dijelaskan.

Tipe: String

Wajib: Tidak

MaxResults

Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika ada lebih banyak catatan daripada MaxResults nilai yang ditentukan, token disertakan dalam respons sehingga hasil yang tersisa dapat diambil.

Tipe: Integer

Wajib: Tidak

NextToken

Argumen opsional untuk lulus jika jumlah total catatan melebihi nilai MaxResults. Jika nextToken dikembalikan, ada lebih banyak hasil yang tersedia. Nilai nextToken adalah token pagination unik untuk setiap halaman. Lakukan panggilan lagi menggunakan token yang dikembalikan untuk mengambil halaman berikutnya. Jaga agar semua argumen lainnya tidak berubah.

Tipe: String

Wajib: Tidak

ShowDetail

Nilai Boolean yang jika benar, konfigurasi shard disertakan dalam deskripsi snapshot.

Tipe: Boolean

Wajib: Tidak

SnapshotName

Nama snapshot yang disediakan pengguna. Jika parameter ini ditentukan, hanya snapshot bernama ini yang dijelaskan.

Tipe: String

Wajib: Tidak

Source

Jika diatur ke sistem, output menunjukkan snapshot yang secara otomatis dibuat oleh MemoryDB. Jika disetel ke pengguna, output menunjukkan snapshot yang dibuat secara manual. Jika dihilangkan, output menunjukkan snapshot yang dibuat secara otomatis dan manual.

Tipe: String

Wajib: Tidak

Sintaksis Respons

{ "NextToken": "string", "Snapshots": [ { "ARN": "string", "ClusterConfiguration": { "Description": "string", "Engine": "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" } ] }

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Data berikut dikembalikan dalam JSON format oleh layanan.

NextToken

Argumen opsional untuk lulus jika jumlah total catatan melebihi nilai MaxResults. Jika nextToken dikembalikan, ada lebih banyak hasil yang tersedia. Nilai nextToken adalah token pagination unik untuk setiap halaman. Lakukan panggilan lagi menggunakan token yang dikembalikan untuk mengambil halaman berikutnya. Jaga agar semua argumen lainnya tidak berubah.

Tipe: String

Snapshots

Daftar snapshot. Setiap item dalam daftar berisi informasi terperinci tentang satu snapshot.

Tipe: Array objek Snapshot

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InvalidParameterCombinationException

HTTPKode Status: 400

InvalidParameterValueException

HTTPKode Status: 400

ServiceLinkedRoleNotFoundFault

HTTPKode Status: 400

SnapshotNotFoundFault

HTTPKode Status: 400

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan ini API di salah satu bahasa khusus AWS SDKs, lihat berikut ini: