ListClusterSnapshots - 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.

ListClusterSnapshots

Mengembalikan informasi tentang snapshot untuk cluster elastis tertentu.

Minta Sintaks

GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

clusterArn

Pengidentifikasi ARN dari cluster elastis.

maxResults

Jumlah maksimum hasil snapshot cluster elastis yang diterima dalam respons.

Rentang Valid: Nilai minimum 20. 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.

snapshotType

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

  • automated- Kembalikan semua snapshot cluster yang Amazon DocumentDB telah secara otomatis dibuat untuk akun Anda. AWS

  • manual- Kembalikan semua snapshot cluster yang telah Anda buat secara manual untuk AWS akun Anda.

Isi Permintaan

Permintaan tidak memiliki isi permintaan.

Sintaks Respons

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "snapshots": [ 
      { 
         "clusterArn": "string",
         "snapshotArn": "string",
         "snapshotCreationTime": "string",
         "snapshotName": "string",
         "status": "string"
      }
   ]
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

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.

Tipe: String

snapshots

Daftar snapshot untuk cluster elastis tertentu.

Tipe: Array objek ClusterSnapshotInList

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.

message

Pesan kesalahan yang menjelaskan mengapa akses ditolak.

Kode Status HTTP: 403

InternalServerException

Ada kesalahan server internal.

Kode Status HTTP: 500

ThrottlingException

ThrottlingException akan dilemparkan ketika permintaan ditolak karena pembatasan permintaan.

retryAfterSeconds

Jumlah detik untuk menunggu sebelum mencoba kembali operasi.

Kode Status HTTP: 429

ValidationException

Struktur yang mendefinisikan pengecualian validasi.

fieldList

Daftar bidang di mana pengecualian validasi terjadi.

message

Pesan kesalahan yang menjelaskan pengecualian validasi.

reason

Alasan mengapa pengecualian validasi terjadi (salah satuunknownOperation,, cannotParsefieldValidationFailed, atauother).

Kode Status HTTP: 400

Lihat Juga

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