DescribeBackupVault - AWS Backup

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

DescribeBackupVault

Mengembalikan metadata tentang brankas cadangan yang ditentukan oleh namanya.

Sintaks Permintaan

GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1

URIParameter Permintaan

Permintaan menggunakan URI parameter berikut.

BackupVaultAccountId

ID akun dari brankas cadangan yang ditentukan.

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.

Wajib: Ya

Isi Permintaan

Permintaan tidak memiliki isi permintaan.

Sintaks Respons

HTTP/1.1 200 Content-type: application/json { "BackupVaultArn": "string", "BackupVaultName": "string", "CreationDate": number, "CreatorRequestId": "string", "EncryptionKeyArn": "string", "LockDate": number, "Locked": boolean, "MaxRetentionDays": number, "MinRetentionDays": number, "NumberOfRecoveryPoints": number, "VaultState": "string", "VaultType": "string" }

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Data berikut dikembalikan dalam JSON format oleh layanan.

BackupVaultArn

Amazon Resource Name (ARN) yang secara unik mengidentifikasi brankas cadangan; misalnya,. arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault

Tipe: String

BackupVaultName

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

Tipe: String

CreationDate

Tanggal dan waktu pembuatan brankas cadangan, 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. Parameter ini bersifat opsional. Jika digunakan, parameter ini harus berisi 1 sampai 50 alfanumerik atau '-_.' karakter.

Tipe: String

EncryptionKeyArn

Kunci enkripsi sisi server yang digunakan untuk melindungi cadangan Anda; misalnya, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

Tipe: String

LockDate

Tanggal dan waktu ketika konfigurasi AWS Backup Vault Lock tidak dapat diubah atau dihapus.

Jika Anda menerapkan Vault Lock ke vault tanpa menentukan tanggal penguncian, Anda dapat mengubah setelan Vault Lock, atau menghapus Vault Lock dari vault sepenuhnya, kapan saja.

Nilai ini dalam format Unix, Waktu Universal Terkoordinasi (UTC), dan akurat hingga milidetik. Misalnya, nilai 1516925490.087 mewakili Jumat, 26 Januari 2018 12:11:30.087.

Tipe: Timestamp

Locked

Boolean yang menunjukkan apakah AWS Backup Vault Lock saat ini melindungi brankas cadangan. Trueberarti bahwa Vault Lock menyebabkan operasi hapus atau perbarui pada titik pemulihan yang disimpan di brankas gagal.

Jenis: Boolean

MaxRetentionDays

Pengaturan AWS Backup Vault Lock yang menentukan periode retensi maksimum tempat vault mempertahankan titik pemulihannya. Jika parameter ini tidak ditentukan, Vault Lock tidak memberlakukan periode retensi maksimum pada titik pemulihan di vault (memungkinkan penyimpanan tidak terbatas).

Jika ditentukan, pekerjaan pencadangan atau penyalinan apa pun ke vault harus memiliki kebijakan siklus hidup dengan periode penyimpanan yang sama atau lebih pendek dari periode retensi maksimum. Jika periode retensi pekerjaan lebih lama dari periode retensi maksimum tersebut, vault akan gagal melakukan pekerjaan pencadangan atau penyalinan, dan Anda harus mengubah setelan siklus hidup atau menggunakan brankas yang berbeda. Titik pemulihan yang sudah disimpan di brankas sebelum Vault Lock tidak terpengaruh.

Tipe: Long

MinRetentionDays

Pengaturan AWS Backup Vault Lock yang menentukan periode retensi minimum tempat vault mempertahankan titik pemulihannya. Jika parameter ini tidak ditentukan, Vault Lock tidak akan menerapkan periode retensi minimum.

Jika ditentukan, pekerjaan pencadangan atau penyalinan apa pun ke vault harus memiliki kebijakan siklus hidup dengan periode penyimpanan yang sama dengan atau lebih lama dari periode penyimpanan minimum. Jika periode retensi pekerjaan lebih pendek dari periode retensi minimum tersebut, vault akan gagal melakukan pekerjaan pencadangan atau penyalinan, dan Anda harus mengubah setelan siklus hidup atau menggunakan brankas yang berbeda. Titik pemulihan yang sudah disimpan di brankas sebelum Vault Lock tidak terpengaruh.

Tipe: Long

NumberOfRecoveryPoints

Jumlah titik pemulihan yang disimpan dalam brankas cadangan.

Tipe: Long

VaultState

Keadaan lemari besi saat ini. ->

Tipe: String

Nilai yang Valid: CREATING | AVAILABLE | FAILED

VaultType

Jenis lemari besi yang dijelaskan.

Tipe: String

Nilai yang Valid: BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT

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.

HTTPKode Status: 400

MissingParameterValueException

Menunjukkan bahwa parameter yang diperlukan tidak ada.

HTTPKode Status: 400

ResourceNotFoundException

Sumber daya yang diperlukan untuk tindakan tidak ada.

HTTPKode Status: 400

ServiceUnavailableException

Permintaan gagal karena kegagalan sementara server.

HTTPKode Status: 500

Lihat Juga

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