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

CopyClusterSnapshot

Menyalin snapshot dari cluster elastis.

Minta Sintaks

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

{
   "copyTags": boolean,
   "kmsKeyId": "string",
   "tags": { 
      "string" : "string" 
   },
   "targetSnapshotName": "string"
}

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

snapshotArn

Pengidentifikasi Amazon Resource Name (ARN) dari snapshot cluster elastis.

Wajib: Ya

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

targetSnapshotName

Pengidentifikasi snapshot cluster elastis baru untuk dibuat dari snapshot cluster sumber. Parameter ini tidak peka huruf besar kecil.

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.

Contoh: elastic-cluster-snapshot-5

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 63.

Wajib: Ya

copyTags

Setel true untuk menyalin semua tag dari snapshot cluster sumber ke snapshot cluster elastis target. Defaultnya adalah false.

Tipe: Boolean

Wajib: Tidak

kmsKeyId

ID kunci AWS KMS untuk snapshot cluster elastis terenkripsi. ID kunci AWS KMS adalah Nama Sumber Daya Amazon (ARN) AWS , pengidentifikasi kunci KMS, atau alias kunci KMS AWS untuk kunci enkripsi KMS. AWS

Jika Anda menyalin snapshot cluster elastis terenkripsi dari AWS akun Anda, Anda dapat menentukan nilai KmsKeyId untuk mengenkripsi salinan dengan kunci enkripsi AWS S KMS baru. Jika Anda tidak menentukan nilai untukKmsKeyId, maka salinan snapshot cluster elastis dienkripsi dengan kunci AWS KMS yang sama dengan snapshot cluster elastis sumber.

Untuk menyalin snapshot cluster elastis terenkripsi ke AWS wilayah lain, atur KmsKeyId ke ID kunci AWS KMS yang ingin Anda gunakan untuk mengenkripsi salinan snapshot cluster elastis di wilayah tujuan. AWS Kunci enkripsi KMS khusus untuk AWS wilayah tempat mereka dibuat, dan Anda tidak dapat menggunakan kunci enkripsi dari satu AWS wilayah di AWS wilayah lain.

Jika Anda menyalin snapshot cluster elastis yang tidak terenkripsi dan menentukan nilai untuk KmsKeyId parameter, kesalahan akan dikembalikan.

Tipe: String

Wajib: Tidak

tags

Tag yang akan ditetapkan ke snapshot cluster elastis.

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

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

{
   "snapshot": { 
      "adminUserName": "string",
      "clusterArn": "string",
      "clusterCreationTime": "string",
      "kmsKeyId": "string",
      "snapshotArn": "string",
      "snapshotCreationTime": "string",
      "snapshotName": "string",
      "snapshotType": "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.

snapshot

Mengembalikan informasi tentang snapshot cluster elastis tertentu.

Tipe: Objek ClusterSnapshot

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: