DescribeBackupVault - Amazon Backup
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DescribeBackupVault

返回由其名称指定的备份保管库的相关元数据。

请求语法

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

URI 请求参数

请求使用以下 URI 参数。

BackupVaultAccountId

这是指定的备份保管库的账户 ID。

backupVaultName

用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 Amazon 区域中是唯一的。名称包含小写字母、数字和连字符。

必需:是

请求体

该请求没有请求体。

响应语法

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, "VaultType": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

BackupVaultArn

唯一标识备份保管库的 Amazon 资源名称 (ARN);例如,arn:aws:backup:us-east-1:123456789012:vault:aBackupVault

类型:字符串

BackupVaultName

用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 区域中是唯一的。名称包含小写字母、数字和连字符。

类型:字符串

CreationDate

备份保管库的创建日期和时间,采用 Unix 时间格式和协调世界时 (UTC)。CreationDate 的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

类型:时间戳

CreatorRequestId

唯一字符串,用于标识请求并允许重试失败的请求,同时避免发生两次运行操作的风险。此参数为可选的。如果使用,则此参数必须包含 1 到 50 个字母数字或“-_.” 字符。

类型:字符串

EncryptionKeyArn

用于保护备份的服务器端加密密钥;例如,arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

类型:字符串

LockDate

无法更改或删除 Amazon Backup 保管库锁定配置的日期和时间。

如果您在未指定锁定日期的情况下对保管库应用了保管库锁定,则可以随时更改任何保管库锁定设置,或从保管库中完全删除保管库锁定。

该值采用 Unix 格式和协调世界时 (UTC),精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

类型:时间戳

Locked

一个布尔值,用于指示 Amazon Backup 保管库锁定当前是否在保护备份保管库。True 表示保管库锁定会导致对存储在保管库中的恢复点执行删除或更新操作失败。

类型:布尔值

MaxRetentionDays

Amazon Backup 保管库锁定设置,用于指定保管库保留其恢复点的最长保留期。如果不指定此参数,则保管库锁定不会对保管库中的恢复点强制规定最长保留期(允许无限期存储)。

如果指定了此参数,则备份或复制到保管库的任何作业都必须具有生命周期策略,其保留期等于或小于最长保留期。如果作业的保留期长于该最长保留期,则保管库将无法执行该备份或复制作业,因此您应该修改生命周期设置或使用其他保管库。保管库锁定之前已存储在保管库中的恢复点不受影响。

类型:长整型

MinRetentionDays

Amazon Backup 保管库锁定设置,用于指定保管库保留其恢复点的最短保留期。如果未指定此参数,则保管库锁定不会强制规定最短保留期。

如果指定了此参数,则备份或复制到保管库的任何作业都必须具有生命周期策略,其保留期等于或大于最短保留期。如果作业的保留期短于该最短保留期,则保管库将无法执行该备份或复制作业,因此,您应该修改生命周期设置或使用其他保管库。保管库锁定之前已存储在保管库中的恢复点不受影响。

类型:长整型

NumberOfRecoveryPoints

存储在备份保管库中的恢复点数量。

类型:长整型

VaultType

这就是所描述的保管库类型。

类型:字符串

有效值:BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT

错误

有关所有操作返回的常见错误的信息,请参阅常见错误

InvalidParameterValueException

表示参数的值有问题。例如,该值超出了范围。

HTTP 状态代码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码:400

ResourceNotFoundException

该操作所需的资源不存在。

HTTP 状态代码:400

ServiceUnavailableException

由于服务器发生临时故障而导致请求失败。

HTTP 状态代码:500

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: