ListClusters - Amazon DocumentDB
Minta SintaksParameter Permintaan URIIsi PermintaanSintaks ResponsElemen ResponsKesalahanLihat Juga

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

ListClusters

Mengembalikan informasi tentang klaster elastis Amazon DocumentDB yang disediakan.

Minta Sintaks

GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

maxResults

Jumlah maksimum hasil snapshot cluster elastis yang diterima dalam respons.

Rentang yang Valid: Nilai minimum 1. Nilai maksimum 100.

nextToken

Token pagination yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya mencakup catatan di luar token ini, hingga nilai yang ditentukan olehmax-results.

Jika tidak ada lagi data dalam respons, tidak nextToken akan dikembalikan.

Isi Permintaan

Permintaan tidak memiliki isi permintaan.

Sintaks Respons

HTTP/1.1 200
Content-type: application/json

{
   "clusters": [ 
      { 
         "clusterArn": "string",
         "clusterName": "string",
         "status": "string"
      }
   ],
   "nextToken": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

clusters

Daftar cluster elastis Amazon DocumentDB.

Tipe: Array objek ClusterInList

nextToken

Token pagination yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respons hanya mencakup catatan di luar token ini, hingga nilai yang ditentukan olehmax-results.

Jika tidak ada lagi data dalam respons, tidak nextToken akan dikembalikan.

Jenis: String

Kesalahan

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

AccessDeniedException

Pengecualian yang terjadi ketika tidak ada izin yang cukup untuk melakukan tindakan.

Kode Status HTTP: 403

InternalServerException

Ada kesalahan server internal.

Kode Status HTTP: 500

ThrottlingException

ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.

Kode Status HTTP: 429

ValidationException

Struktur yang mendefinisikan pengecualian validasi.

Kode Status HTTP: 400

Lihat Juga

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