RestoreClusterFromSnapshot - Amazon DocumentDB
Minta SintaksParameter Permintaan URIIsi PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

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

RestoreClusterFromSnapshot

Mengembalikan cluster elastis dari snapshot.

Minta Sintaks

POST /cluster-snapshot/snapshotArn/restore HTTP/1.1
Content-type: application/json

{
   "clusterName": "string",
   "kmsKeyId": "string",
   "shardCapacity": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "vpcSecurityGroupIds": [ "string" ]
}

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

snapshotArn

Pengidentifikasi ARN dari snapshot cluster elastis.

Wajib: Ya

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

clusterName

Nama cluster elastis.

Tipe: String

Diperlukan: Ya

kmsKeyId

Pengidentifikasi kunci KMS yang digunakan untuk mengenkripsi cluster elastis Amazon DocumentDB baru.

Pengidentifikasi kunci KMS adalah Amazon Resource Name (ARN) untuk kunci enkripsi KMS. Jika Anda membuat cluster menggunakan akun Amazon yang sama yang memiliki kunci enkripsi KMS ini, Anda dapat menggunakan alias kunci KMS alih-alih ARN sebagai kunci enkripsi KMS.

Jika kunci enkripsi tidak ditentukan di sini, Amazon DocumentDB menggunakan kunci enkripsi default yang dibuat KMS untuk akun Anda. Akun Anda memiliki kunci enkripsi default yang berbeda untuk setiap Wilayah Amazon.

Tipe: String

Wajib: Tidak

shardCapacity

Kapasitas setiap pecahan dalam cluster elastis baru yang dipulihkan.

Tipe: Integer

Wajib: Tidak

shardInstanceCount

Jumlah contoh replika yang berlaku untuk semua pecahan di cluster elastis. shardInstanceCountNilai 1 berarti ada satu contoh penulis, dan setiap contoh tambahan adalah replika yang dapat digunakan untuk membaca dan untuk meningkatkan ketersediaan.

Tipe: Integer

Wajib: Tidak

subnetIds

ID subnet Amazon EC2 untuk cluster elastis.

Tipe: Array string

Wajib: Tidak

tags

Daftar nama tag yang akan ditetapkan ke cluster elastis yang dipulihkan, dalam bentuk array pasangan kunci-nilai di mana kuncinya adalah nama tag dan nilainya adalah nilai kunci.

Tipe: Peta string ke string

Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.

Pola Kunci: ^(?!aws:)[a-zA-Z+-=._:/]+$

Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.

Wajib: Tidak

vpcSecurityGroupIds

Daftar grup keamanan VPC EC2 untuk diasosiasikan dengan cluster elastis.

Tipe: Array string

Wajib: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

cluster

Mengembalikan informasi tentang cluster elastis dipulihkan.

Tipe: Objek Cluster

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

ConflictException

Terjadi konflik akses.

Kode Status HTTP: 409

InternalServerException

Ada kesalahan server internal.

Kode Status HTTP: 500

ResourceNotFoundException

Sumber daya yang ditentukan tidak dapat ditemukan.

Kode Status HTTP: 404

ServiceQuotaExceededException

Kuota layanan untuk tindakan terlampaui.

Kode Status HTTP: 402

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: