Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
DescribeDBClusters
Mengembalikan informasi tentang klaster Amazon DocumentDB yang disediakan. Operasi API ini mendukung pagination (pemberian nomor halaman). Untuk fitur manajemen tertentu seperti manajemen siklus hidup klaster dan instans, Amazon DocumentDB memanfaatkan teknologi operasional yang dibagikan dengan Amazon RDS dan Amazon Neptune. Gunakan parameter filter filterName=engine,Values=docdb untuk mengembalikan hanya klaster Amazon DocumentDB.
Parameter Permintaan
Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.
- DBClusterIdentifier
-
Pengidentifikasi klaster yang disediakan pengguna. Jika parameter ini ditentukan, informasi hanya dari klaster tertentu yang dikembalikan. Parameter ini tidak peka huruf besar kecil.
Batasan:
-
Jika disediakan, harus cocok dengan
DBClusterIdentifieryang ada.
Tipe: String
Wajib: Tidak
-
- Filter.Filter.N
-
Filter yang menentukan satu atau lebih klaster untuk dideskripsikan.
Filter yang didukung:
-
db-cluster-id- Menerima pengidentifikasi klaster dan Amazon Resource Name (ARN) klaster. Daftar hasil hanya mencakup informasi tentang klaster yang diidentifikasi oleh ARN ini.
Tipe: Array objek Filter
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
MaxRecordsyang 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
Elemen Respons
Elemen-elemen berikut dikembalikan oleh layanan.
- dbclusters.dbcluster.n
-
Sebuah daftar klaster.
Tipe: Array objek DBCluster
- 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.
- DBClusterNotFoundFault
-
DBClusterIdentifiertidak mengacu ke sebuah 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:
