本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
DescribeBackupVault
傳回備份保存庫 (由其名稱所指定) 的相關中繼資料。
請求語法
GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
URI 請求參數
請求使用以下URI參數。
- BackupVaultAccountId
-
指定備份保存庫的帳戶 ID。
- backupVaultName
-
存放備份的邏輯容器的名稱。備份文件庫依名稱識別，這些名稱對建立文件庫的帳戶和 AWS 區域來說是唯一的。
必要：是
請求主體
請求沒有請求主體。
回應語法
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"
}回應元素
如果動作成功，服務會傳回 200 HTTP 個回應。
服務會以 JSON 格式傳回下列資料。
- BackupVaultArn
-
可唯一識別備份保存庫的 Amazon Resource Name （ARN）；例如
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault。類型：字串
- BackupVaultName
-
存放備份的邏輯容器的名稱。備份文件庫依名稱識別，這些名稱對用於建立文件庫的帳戶和區域來說是唯一的。
類型：字串
- CreationDate
-
建立備份保存庫的日期和時間，採用 Unix 格式和國際標準時間 （UTC）。
CreationDate的值精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。類型：Timestamp
- CreatorRequestId
-
可識別請求的唯一字串，且允許重試失敗的請求，而不會有兩次執行操作的風險。此為選用參數。如果使用，此參數必須包含 1 至 50 個英數字元或 '-_'。字元。
類型：字串
- EncryptionKeyArn
-
用來保護備份的伺服器端加密金鑰，例如
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab。類型：字串
- LockDate
-
無法變更或刪除 AWS Backup 保存庫鎖定組態的日期和時間。
如果在未指定鎖定日期的情況下，將「Vault Lock 」套用至保存庫，則可隨時變更任何「Vault Lock 」設定，或從保存庫中完全刪除「Vault Lock 」。
此值採用 Unix 格式、國際標準時間 （UTC） 和精確到毫秒。例如，值 1516925490.087 代表 2018 年 1 月 26 日星期五上午 12 點 11 分 30.087 秒。
類型：Timestamp
- Locked
-
指出 AWS Backup 保存庫鎖定目前是否正在保護備份保存庫的布林值。
True表示保存庫鎖定會導致在保存庫中存放的復原點上的刪除或更新操作失敗。類型：布林值
- MaxRetentionDays
-
保存 AWS Backup 庫鎖定設定，指定保存庫保留其復原點的最長保留期。若未指定此參數，Vault Lock 不會對保存庫中的復原點強制執行最長保留期間 (允許無限期儲存)。
若經過指定，則保存庫的所有備份或複製任務皆必須具有生命週期政策，其保留期間等於或短於最長保留期間。若任務的保留期間超過該最長保留期間，則文件庫的備份或複製任務會失敗，您應修改生命週期設定或使用不同的文件庫。在執行Vault Lock 之前已儲存於保存庫的復原點不會受到影響。
類型：Long
- MinRetentionDays
-
保存 AWS Backup 庫鎖定設定，指定保存庫保留其復原點的最短保留期。若未指定此參數，Vault Lock 將不會強制執行最短保留期間。
若經過指定，則保存庫的所有備份或複製任務皆必須具有生命週期政策，其保留期間等於或超過最短保留期間。若任務的保留期間未達最短保留期間，則保存庫的備份或複製任務會失敗，您應修改生命週期設定或使用不同的保存庫。在執行Vault Lock 之前已儲存於保存庫的復原點不會受到影響。
類型：Long
- NumberOfRecoveryPoints
-
儲存在備份保存庫中的復原點數目。
類型：Long
- VaultState
-
保存庫的目前狀態。->
類型：字串
有效值:
CREATING | AVAILABLE | FAILED - VaultType
-
所述的保存庫類型。
類型：字串
有效值:
BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT
錯誤
如需所有動作常見錯誤的資訊，請參閱常見錯誤。
- InvalidParameterValueException
-
表示參數的值出現問題。例如，值超出範圍。
HTTP 狀態碼：400
- MissingParameterValueException
-
表示缺少必要的參數。
HTTP 狀態碼：400
- ResourceNotFoundException
-
動作所需的資源不存在。
HTTP 狀態碼：400
- ServiceUnavailableException
-
由於伺服器發生臨時故障，請求失敗。
HTTP 狀態碼：500
另請參閱
如需在其中一種語言特定的 API中使用此功能的詳細資訊 AWS SDKs，請參閱下列內容：
