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

RestoreDBClusterToPointInTime

Memulihkan klaster ke titik waktu yang arbitrer. Pengguna dapat memulihkan ke titik waktu mana pun sebelum LatestRestorableTime hingga BackupRetentionPeriod hari. Klaster target dibuat dari klaster sumber dengan konfigurasi yang sama seperti klaster asli, kecuali klaster baru dibuat dengan grup keamanan default.

Parameter Permintaan

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

DBClusterIdentifier

Nama klaster baru yang akan dibuat.

Batas:

  • Harus berisi 1 hingga 63 huruf, angka, atau tanda hubung.

  • Karakter pertama harus berupa huruf.

  • Tidak dapat diakhiri dengan tanda hubung atau mengandung dua tanda hubung berturut-turut.

Tipe: String

Diperlukan: Ya

SourceDBClusterIdentifier

Pengidentifikasi klaster sumber yang akan dipulihkan.

Batasan:

  • Harus cocok dengan pengidentifikasi DBCluster yang ada.

Tipe: String

Diperlukan: Ya

DBSubnetGroupName

Nama grup subnet yang akan digunakan untuk klaster baru.

Kendala: Jika disediakan, harus cocok dengan nama DBSubnetGroup yang ada.

Contoh: mySubnetgroup

Tipe: String

Wajib: Tidak

DeletionProtection

Menentukan apakah klaster ini dapat dihapus. Jika DeletionProtection diaktifkan, klaster tidak dapat dihapus kecuali jika diubah dan DeletionProtection dinonaktifkan. DeletionProtection melindungi klaster agar tidak terhapus secara tidak sengaja.

Tipe: Boolean

Wajib: Tidak

EnableCloudwatchLogsExports.member.n

Daftar jenis log yang harus diaktifkan untuk mengekspor ke Amazon CloudWatch Logs.

Tipe: Array string

Wajib: Tidak

KmsKeyId

Pengidentifikasi AWS KMS kunci yang akan digunakan saat memulihkan cluster terenkripsi dari cluster terenkripsi.

Pengidentifikasi AWS KMS kunci adalah Amazon Resource Name (ARN) untuk kunci enkripsi AWS KMS . Jika Anda memulihkan cluster dengan yang sama Akun AWS yang memiliki kunci AWS KMS enkripsi yang digunakan untuk mengenkripsi cluster baru, maka Anda dapat menggunakan alias AWS KMS kunci alih-alih ARN untuk kunci enkripsi. AWS KMS

Anda dapat mengembalikan ke cluster baru dan mengenkripsi cluster baru dengan AWS KMS kunci yang berbeda dari AWS KMS kunci yang digunakan untuk mengenkripsi cluster sumber. Cluster DB baru dienkripsi dengan AWS KMS kunci yang diidentifikasi oleh parameter. KmsKeyId

Jika Anda tidak menentukan nilai untuk parameter KmsKeyId, maka hal berikut akan terjadi:

  • Jika cluster dienkripsi, maka cluster yang dipulihkan dienkripsi menggunakan AWS KMS kunci yang digunakan untuk mengenkripsi cluster sumber.

  • Jika klaster tidak dienkripsi, maka klaster yang dipulihkan tidak dienkripsi.

Jika DBClusterIdentifier mengacu pada sebuah klaster yang tidak dienkripsi, maka permintaan pemulihan ditolak.

Tipe: String

Wajib: Tidak

Port

Nomor port tempat klaster baru menerima koneksi.

Kendala: Harus berupa nilai dari 1150 hingga 65535.

Default: Port default untuk mesin.

Tipe: Integer

Wajib: Tidak

RestoreToTime

Tanggal dan waktu untuk memulihkan klaster.

Nilai yang valid: Waktu dalam format Waktu Universal Terkoordinasi (UTC).

Batasan:

  • Harus sebelum waktu pemulihan terbaru untuk instans.

  • Harus ditentukan jika parameter UseLatestRestorableTime tidak disediakan.

  • Tidak dapat ditentukan jika parameter UseLatestRestorableTime adalah true.

  • Tidak dapat ditentukan jika parameter RestoreType adalah copy-on-write.

Contoh: 2015-03-07T23:45:00Z

Tipe: Timestamp

Wajib: Tidak

RestoreType

Tipe pemulihan yang akan dilakukan. Anda dapat menentukan salah satu nilai berikut:

  • full-copy - Klaster DB baru dipulihkan sebagai salinan lengkap dari klaster DB sumber.

  • copy-on-write - Klaster DB baru dipulihkan sebagai klon dari klaster DB sumber.

Kendala: Anda tidak dapat menentukan copy-on-write jika versi mesin klaster DB sumber lebih awal dari 1,11.

Jika Anda tidak menentukan RestoreType nilai, maka klaster DB baru dipulihkan sebagai salinan lengkap klaster DB sumber.

Tipe: String

Wajib: Tidak

StorageType

Jenis penyimpanan untuk mengasosiasikan dengan cluster DB.

Untuk informasi tentang jenis penyimpanan untuk klaster Amazon DocumentDB, lihat Konfigurasi penyimpanan klaster di Panduan Pengembang Amazon DocumentDB.

Nilai yang valid untuk jenis penyimpanan - standard | iopt1

Nilai default adalah standard

Tipe: String

Wajib: Tidak

Tags.Tag.N

Tag yang akan ditetapkan ke klaster yang dipulihkan.

Tipe: Array objek Tag

Wajib: Tidak

UseLatestRestorableTime

Nilai yang diatur ke true untuk memulihkan klaster ke waktu backup terbaru yang dapat dipulihkan, dan false sebaliknya.

Default: false

Kendala: Tidak dapat ditentukan jika parameter RestoreToTime disediakan.

Tipe: Boolean

Wajib: Tidak

VpcSecurityGroupIds. VpcSecurityGroupId.N

Daftar grup keamanan VPC tempat klaster baru berada.

Tipe: Array string

Wajib: Tidak

Elemen Respons

Elemen berikut dikembalikan oleh layanan.

DBCluster

Informasi mendetail tentang klaster.

Tipe: Objek DBCluster

Kesalahan

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

DBClusterAlreadyExistsFault

Anda sudah memiliki klaster dengan pengidentifikasi yang diberikan.

Kode Status HTTP: 400

DBClusterNotFoundFault

DBClusterIdentifier tidak mengacu ke sebuah klaster yang ada.

Kode Status HTTP: 404

DBClusterQuotaExceededFault

Klaster tidak dapat dibuat karena Anda telah mencapai kuota maksimum klaster yang diizinkan.

Kode Status HTTP: 403

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier tidak mengacu ke sebuah snapshot klaster yang ada.

Kode Status HTTP: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupName tidak mengacu ke grup subnet yang ada.

Kode Status HTTP: 404

InsufficientDBClusterCapacityFault

Klaster tidak memiliki kapasitas yang cukup untuk operasi saat ini.

Kode Status HTTP: 403

InsufficientStorageClusterCapacity

Tidak ada cukup penyimpanan yang tersedia untuk tindakan saat ini. Anda mungkin dapat mengatasi kesalahan ini dengan memperbarui grup subnet Anda untuk menggunakan Availability Zone berbeda yang memiliki lebih banyak penyimpanan yang tersedia.

Kode Status HTTP: 400

InvalidDBClusterSnapshotStateFault

Nilai yang diberikan bukan status snapshot klaster yang valid.

Kode Status HTTP: 400

InvalidDBClusterStateFault

Klaster tidak dalam status valid.

Kode Status HTTP: 400

InvalidDBSnapshotState

Status snapshot tidak mengizinkan penghapusan.

Kode Status HTTP: 400

InvalidRestoreFault

Anda tidak dapat memulihkan dari backup virtual private cloud (VPC) ke instans DB non-VPC.

Kode Status HTTP: 400

InvalidSubnet

Subnet yang diminta tidak valid, atau beberapa subnet yang diminta tidak semuanya berada dalam virtual private cloud (VPC) yang umum.

Kode Status HTTP: 400

InvalidVPCNetworkStateFault

Grup subnet tidak mencakup semua Availability Zone setelah dibuat karena perubahan yang dibuat.

Kode Status HTTP: 400

KMSKeyNotAccessibleFault

Terjadi kesalahan saat mengakses AWS KMS kunci.

Kode Status HTTP: 400

StorageQuotaExceeded

Permintaan akan menyebabkan Anda melebihi jumlah penyimpanan yang diizinkan yang tersedia di semua instans.

Kode Status HTTP: 400

Lihat Juga

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