GetBackupPlan - AWS Backup
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.

GetBackupPlan

Mengembalikan BackupPlan rincian untuk yang ditentukanBackupPlanId. Detailnya adalah badan rencana cadangan dalam format JSON, selain metadata rencana.

Minta Sintaks

GET /backup/plans/backupPlanId/?MaxScheduledRunsPreview=MaxScheduledRunsPreview&versionId=VersionId HTTP/1.1

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

backupPlanId

Secara unik mengidentifikasi rencana cadangan.

Wajib: Ya

MaxScheduledRunsPreview

Jumlah pencadangan terjadwal masa depan berjalan untuk pratinjau. Saat disetel ke 0 (default), tidak ada pratinjau berjalan terjadwal yang disertakan dalam respons. Rentang yang valid adalah 0-10.

Rentang yang Valid: Nilai minimum 0. Nilai maksimum 10.

VersionId

String berkode UTF-8, Unicode, yang dihasilkan secara acak dan unik, dengan panjang maksimal 1.024 byte. Versi IDs tidak dapat diedit.

Isi Permintaan

Permintaan tidak memiliki isi permintaan.

Sintaks Respons

HTTP/1.1 200
Content-type: application/json

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleId": "string",
            "RuleName": "string",
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string"
         }
      ]
   },
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "CreatorRequestId": "string",
   "DeletionDate": number,
   "LastExecutionDate": number,
   "ScheduledRunsPreview": [ 
      { 
         "ExecutionTime": number,
         "RuleExecutionType": "string",
         "RuleId": "string"
      }
   ],
   "VersionId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

AdvancedBackupSettings

Berisi daftar BackupOptions untuk setiap jenis sumber daya. Daftar diisi hanya jika opsi lanjutan diatur untuk paket cadangan.

Tipe: Array objek AdvancedBackupSetting

BackupPlan

Menentukan badan rencana cadangan. Termasuk satu BackupPlanName dan satu atau lebih setRules.

Tipe: Objek BackupPlan

BackupPlanArn

Nama Sumber Daya Amazon (ARN) yang secara unik mengidentifikasi rencana cadangan; misalnya,. arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50

Tipe: String

BackupPlanId

Secara unik mengidentifikasi rencana cadangan.

Tipe: String

CreationDate

Tanggal dan waktu rencana 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

CreatorRequestId

String unik yang mengidentifikasi permintaan dan memungkinkan permintaan yang gagal untuk dicoba ulang tanpa risiko menjalankan operasi dua kali.

Tipe: String

DeletionDate

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

Tipe: Timestamp

LastExecutionDate

Terakhir kali rencana cadangan ini dijalankan. Tanggal dan waktu, dalam format Unix dan Coordinated Universal Time (UTC). Nilai akurat LastExecutionDate untuk milidetik. Misalnya, nilai 1516925490.087 mewakili Jumat, 26 Januari 2018 12:11:30.087.

Tipe: Timestamp

ScheduledRunsPreview

Daftar proses pencadangan terjadwal yang akan datang. Hanya disertakan ketika MaxScheduledRunsPreview parameter lebih besar dari 0. Berisi hingga 10 eksekusi cadangan masa depan dengan waktu yang dijadwalkan, jenis eksekusi, dan aturan IDs terkait.

Tipe: Array objek ScheduledPlanExecutionMember

VersionId

String berkode UTF-8, Unicode, yang dihasilkan secara acak dan unik, dengan panjang maksimal 1.024 byte. Versi IDs tidak dapat diedit.

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.

Context

Type

Kode Status HTTP: 400

MissingParameterValueException

Menunjukkan bahwa parameter yang diperlukan tidak ada.

Context

Type

Kode Status HTTP: 400

ResourceNotFoundException

Sumber daya yang diperlukan untuk tindakan tidak ada.

Context

Type

Kode Status HTTP: 400

ServiceUnavailableException

Permintaan gagal karena kegagalan sementara server.

Context

Type

Kode Status HTTP: 500

Lihat Juga

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