StartBackupJob - AWS Backup

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

StartBackupJob

Memulai pekerjaan pencadangan sesuai permintaan untuk sumber daya yang ditentukan.

Minta Sintaks

PUT /backup-jobs HTTP/1.1 Content-type: application/json { "BackupOptions": { "string" : "string" }, "BackupVaultName": "string", "CompleteWindowMinutes": number, "IamRoleArn": "string", "IdempotencyToken": "string", "Index": "string", "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "RecoveryPointTags": { "string" : "string" }, "ResourceArn": "string", "StartWindowMinutes": number }

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

BackupOptions

Opsi cadangan untuk sumber daya yang dipilih. Opsi ini hanya tersedia untuk pekerjaan cadangan Windows Volume Shadow Copy Service (VSS).

Nilai yang valid: Setel "WindowsVSS":"enabled" untuk mengaktifkan opsi WindowsVSS cadangan dan membuat cadangan Windows VSS. Setel "WindowsVSS""disabled" untuk membuat cadangan reguler. WindowsVSSOpsi ini tidak diaktifkan secara default.

Tipe: Peta string ke string

Pola Kunci: ^[a-zA-Z0-9\-\_\.]{1,50}$

Pola nilai: ^[a-zA-Z0-9\-\_\.]{1,50}$

Wajib: Tidak

BackupVaultName

Nama kontainer logis tempat cadangan disimpan. Vault cadangan diidentifikasi berdasarkan nama yang unik untuk akun yang digunakan untuk membuatnya dan Wilayah AWS tempatnya dibuat.

Tipe: String

Pola: ^[a-zA-Z0-9\-\_]{2,50}$

Wajib: Ya

CompleteWindowMinutes

Nilai dalam hitungan menit di mana pencadangan yang berhasil dimulai harus diselesaikan, atau AWS Backup akan membatalkan pekerjaan. Nilai ini bersifat opsional. Nilai ini mulai menghitung mundur dari saat cadangan dijadwalkan. Itu tidak menambah waktu tambahan untukStartWindowMinutes, atau jika cadangan dimulai lebih lambat dari yang dijadwalkan.

SepertiStartWindowMinutes, parameter ini memiliki nilai maksimum 100 tahun (52.560.000 menit).

Tipe: Panjang

Wajib: Tidak

IamRoleArn

Menentukan peran IAM ARN digunakan untuk membuat titik pemulihan target; misalnya,. arn:aws:iam::123456789012:role/S3Access

Tipe: String

Diperlukan: Ya

IdempotencyToken

String yang dipilih pelanggan yang dapat Anda gunakan untuk membedakan antara panggilan yang identik. StartBackupJob Mencoba kembali permintaan yang berhasil dengan token idempotensi yang sama menghasilkan pesan sukses tanpa tindakan yang diambil.

Tipe: String

Wajib: Tidak

Index

Sertakan parameter ini untuk mengaktifkan pembuatan indeks jika pekerjaan cadangan Anda memiliki jenis sumber daya yang mendukung indeks cadangan.

Jenis sumber daya yang mendukung indeks cadangan meliputi:

  • EBSuntuk Amazon Elastic Block Store

  • S3untuk Amazon Simple Storage Service (Amazon S3)

Indeks dapat memiliki 1 dari 2 nilai yang mungkin, baik ENABLED atauDISABLED.

Untuk membuat indeks cadangan untuk titik ACTIVE pemulihan yang memenuhi syarat yang belum memiliki indeks cadangan, tetapkan nilai keENABLED.

Untuk menghapus indeks cadangan, tetapkan nilai keDISABLED.

Tipe: String

Nilai yang Valid: ENABLED | DISABLED

Wajib: Tidak

Lifecycle

Siklus hidup menentukan kapan sumber daya yang dilindungi dialihkan ke penyimpanan dingin dan kapan sumber daya tersebut kedaluwarsa. AWS Backup akan transisi dan kedaluwarsa backup secara otomatis sesuai dengan siklus hidup yang Anda tentukan.

Backup yang dialihkan ke penyimpanan dingin harus disimpan dalam penyimpanan dingin minimal 90 hari. Oleh karena itu, pengaturan “retensi” harus 90 hari lebih besar dari pengaturan “transisi ke dingin setelah hari”. Pengaturan “transisi ke dingin setelah hari” tidak dapat diubah setelah cadangan dialihkan ke dingin.

Jenis sumber daya yang dapat bertransisi ke penyimpanan dingin tercantum dalam tabel Ketersediaan fitur menurut sumber daya. AWS Backup mengabaikan ekspresi ini untuk jenis sumber daya lainnya.

Parameter ini memiliki nilai maksimum 100 tahun (36.500 hari).

Tipe: Objek Lifecycle

Wajib: Tidak

RecoveryPointTags

Tag untuk menetapkan sumber daya.

Tipe: Peta antar string

Wajib: Tidak

ResourceArn

Nama Sumber Daya Amazon (ARN) yang secara unik mengidentifikasi sumber daya. Format ARN tergantung pada jenis sumber daya.

Tipe: String

Diperlukan: Ya

StartWindowMinutes

Nilai dalam hitungan menit setelah pencadangan dijadwalkan sebelum pekerjaan akan dibatalkan jika tidak berhasil dimulai. Nilai ini opsional, dan defaultnya adalah 8 jam. Jika nilai ini disertakan, setidaknya harus 60 menit untuk menghindari kesalahan.

Parameter ini memiliki nilai maksimum 100 tahun (52.560.000 menit).

Selama jendela mulai, status pekerjaan cadangan tetap dalam CREATED status sampai berhasil dimulai atau sampai waktu jendela mulai habis. Jika dalam waktu jendela mulai AWS Backup menerima kesalahan yang memungkinkan pekerjaan untuk dicoba lagi, secara otomatis AWS Backup akan mencoba lagi untuk memulai pekerjaan setidaknya setiap 10 menit sampai pencadangan berhasil dimulai (status pekerjaan berubah menjadiRUNNING) atau sampai status pekerjaan berubah menjadi EXPIRED (yang diharapkan terjadi ketika waktu jendela mulai selesai).

Tipe: Panjang

Wajib: Tidak

Sintaksis Respons

HTTP/1.1 200 Content-type: application/json { "BackupJobId": "string", "CreationDate": number, "IsParent": boolean, "RecoveryPointArn": "string" }

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

BackupJobId

Secara unik mengidentifikasi permintaan AWS Backup untuk membuat cadangan sumber daya.

Tipe: String

CreationDate

Tanggal dan waktu pekerjaan cadangan dibuat, dalam format Unix dan Coordinated Universal Time (UTC). Nilai akurat CreationDate untuk milidetik. Misalnya, nilai 1516925490.087 mewakili Jumat, 26 Januari 2018 12:11:30.087.

Tipe: Timestamp

IsParent

Ini adalah nilai boolean yang dikembalikan yang menunjukkan ini adalah pekerjaan cadangan induk (komposit).

Jenis: Boolean

RecoveryPointArn

Catatan: Bidang ini hanya dikembalikan untuk sumber daya Amazon EFS dan Advanced DynamoDB.

ARN yang secara unik mengidentifikasi titik pemulihan; misalnya,. arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45

Tipe: String

Kesalahan

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

InvalidParameterValueException

Menunjukkan bahwa ada sesuatu yang salah dengan nilai parameter. Misalnya, nilainya di luar jangkauan.

Kode Status HTTP: 400

InvalidRequestException

Menunjukkan bahwa ada sesuatu yang salah dengan input ke permintaan. Misalnya, parameter adalah tipe yang salah.

Kode Status HTTP: 400

LimitExceededException

Batas permintaan telah terlampaui; misalnya, jumlah maksimum item yang diizinkan dalam permintaan.

Kode Status HTTP: 400

MissingParameterValueException

Menunjukkan bahwa parameter yang diperlukan tidak ada.

Kode Status HTTP: 400

ResourceNotFoundException

Sumber daya yang diperlukan untuk tindakan tidak ada.

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena kegagalan sementara server.

Kode Status HTTP: 500

Lihat Juga

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