DescribeDBClusterSnapshots - Amazon DocumentDB
Parameter PermintaanElemen ResponsKesalahanLihat Juga

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

DescribeDBClusterSnapshots

Mengembalikan informasi tentang snapshot klaster. Operasi API ini mendukung pagination (pemberian nomor halaman).

Parameter Permintaan

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

DBClusterIdentifier

ID dari klaster untuk mengambil daftar snapshot klaster. Parameter ini tidak dapat digunakan dengan parameter DBClusterSnapshotIdentifier. Parameter ini tidak peka huruf besar kecil.

Batasan:

  • Jika disediakan, harus cocok dengan pengidentifikasi DBCluster yang ada.

Tipe: String

Wajib: Tidak

DBClusterSnapshotIdentifier

Pengidentifikasi snapshot klaster tertentu untuk menggambarkan. Parameter ini tidak dapat digunakan dengan parameter DBClusterIdentifier. Nilai ini disimpan sebagai string huruf kecil.

Batasan:

  • Jika disediakan, harus cocok dengan pengidentifikasi DBClusterSnapshot yang ada.

  • Jika pengidentifikasi ini adalah untuk snapshot otomatis, parameter SnapshotType juga harus ditentukan.

Tipe: String

Wajib: Tidak

Filter.Filter.N

Parameter ini saat ini tidak didukung.

Tipe: Array objek Filter

Wajib: Tidak

IncludePublic

Setel true untuk menyertakan snapshot cluster manual yang bersifat publik dan dapat disalin atau dipulihkan oleh siapa pun Akun AWS, dan sebaliknya. false Defaultnya adalah false.

Tipe: Boolean

Wajib: Tidak

IncludeShared

Setel true untuk menyertakan snapshot cluster manual bersama dari Akun AWS yang lain yang Akun AWS telah diberi izin untuk menyalin atau memulihkan, dan sebaliknyafalse. Defaultnya adalah false.

Tipe: Boolean

Wajib: Tidak

Marker

Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

Tipe: String

Wajib: Tidak

MaxRecords

Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai MaxRecords yang ditentukan, token pagination / pemberian nomor halaman (penanda) disertakan dalam respons sehingga hasil yang tersisa dapat diambil.

Default: 100

Kendala: Minimum 20, maksimum 100.

Tipe: Integer

Wajib: Tidak

SnapshotType

Jenis snapshot klaster untuk dikembalikan. Anda dapat menentukan salah satu nilai berikut:

  • automated - Mengembalikan semua snapshot klaster yang telah dibuat secara otomatis oleh Amazon DocumentDB untuk Akun AWS Anda.

  • manual - Mengembalikan semua snapshot klaster yang telah Anda buat secara manual untuk Akun AWS Anda.

  • shared - Mengembalikan semua snapshot klaster manual yang telah dibagikan ke Akun AWS Anda.

  • public - Mengembalikan semua snapshot klaster yang telah ditandai sebagai publik.

Jika Anda tidak menentukan nilai SnapshotType, maka baik snapshot klaster otomatis dan manual dikembalikan. Anda dapat menyertakan snapshot klaster bersama dengan hasil ini dengan mengatur parameter IncludeShared ke true. Anda dapat menyertakan snapshot klaster publik dengan hasil ini dengan mengatur parameter IncludePublic ke true.

Parameter IncludeShared dan IncludePublic tidak berlaku untuk nilai SnapshotType dari manual atau automated. Parameter IncludePublic tidak berlaku bila SnapshotType diatur ke shared. Parameter IncludeShared tidak berlaku bila SnapshotType diatur ke public.

Tipe: String

Wajib: Tidak

Elemen Respons

Elemen-elemen berikut dikembalikan oleh layanan.

DB ClusterSnapshots .DB .N ClusterSnapshot

Menyediakan daftar snapshot klaster.

Tipe: Array objek DBClusterSnapshot

Marker

Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

Jenis: String

Kesalahan

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

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier tidak mengacu ke sebuah snapshot klaster yang ada.

Kode Status HTTP: 404

Lihat Juga

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