Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
DescribeDBInstances
Mengembalikan informasi tentang instans Amazon DocumentDB yang disediakan. API ini mendukung pagination (pemberian nomor halaman).
Parameter Permintaan
Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.
- DBInstanceIdentifier
-
Pengidentifikasi instans yang disediakan pengguna. Jika parameter ini ditentukan, informasi hanya dari instans tertentu yang dikembalikan. Parameter ini tidak peka huruf besar kecil.
Batasan:
-
Jika disediakan, harus cocok dengan pengidentifikasi
DBInstanceyang ada.
Tipe: String
Wajib: Tidak
-
- Filter.Filter.N
-
Filter yang menentukan satu atau lebih instans untuk dideskripsikan.
Filter yang didukung:
-
db-cluster-id- Menerima pengidentifikasi klaster dan Amazon Resource Name (ARN) klaster. Daftar hasil mencakup hanya informasi tentang instans yang terkait dengan klaster yang diidentifikasi oleh ARN ini. -
db-instance-id- Menerima pengidentifikasi instans dan ARN instans. Daftar hasil mencakup hanya informasi tentang instans 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.
- dbInstances.dbInstance.n
-
Informasi mendetail tentang satu atau lebih instans.
Tipe: Array objek DBInstance
- 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.
- DBInstanceNotFound
-
DBInstanceIdentifiertidak mengacu ke sebuah instans 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:
