本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
DescribeBackupVault
返回有关由其名称指定的备份库的元数据。
请求语法
GET /backup-vaults/backupVaultName HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
- 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
}响应元素
如果此操作成功，则该服务将会发送回 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。类型：Timestamp
- CreatorRequestId
-
用于标识请求的唯一字符串，用于重试失败的请求，而不会产生运行两次操作的风险。
类型：字符串
- EncryptionKeyArn
-
用于保护备份的服务器端加密密钥；例如，
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab。类型：字符串
- LockDate
-
无法更改或删除AWS Backup保管库锁定配置的日期和时间。
如果您在未指定锁定日期的情况下对保管库应用了保管库锁定，则可以随时更改任何保管库锁定设置，或者从保管库中完全删除保管库锁定。
此值采用 Unix 格式，即协调世界时 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30 .087。
类型：Timestamp
- Locked
-
一个布尔值，用于指示AWS Backup Vault Lock 当前是否在保护备份保管库。
True意味着保管库锁定会导致对存储在保管库中的恢复点执行删除或更新操作失败。类型：布尔值
- MaxRetentionDays
-
文件AWS Backup库锁定设置，用于指定文件库保留其恢复点的最长保留期。如果未指定此参数，文件库锁定不会对文件库中的恢复点强制规定最长保留期（允许无限期存储）。
如果指定，则文件库的任何备份或复制作业都必须具有生命周期策略，其保留期等于或小于最长保留期。如果作业的保留期长于该最长保留期，则文件库将无法执行备份或复制作业，因此您应该修改生命周期设置或使用其他文件库。文件库锁定之前已存储在文件库中的恢复点不受影响。
类型：长整型
- MinRetentionDays
-
文件AWS Backup库锁定设置，用于指定文件库保留其恢复点的最短保留期。如果未指定此参数，文件库锁定不会强制规定最短保留期。
如果指定，则文件库的任何备份或复制作业都必须具有生命周期策略，其保留期等于或大于最短保留期。如果作业的保留期短于该最短保留期，则文件库将无法执行备份或复制作业，因此您应该修改生命周期设置或使用其他文件库。文件库锁定之前已存储在文件库中的恢复点不受影响。
类型：长整型
- NumberOfRecoveryPoints
-
存储在备份库中的恢复点数量。
类型：长整型
错误
有关所有操作常见错误的信息，请参阅常见错误。
- InvalidParameterValueException
-
表示参数的值有问题。例如，该值超出范围。
HTTP 状态代码：400
- MissingParameterValueException
-
表示缺少必填参数。
HTTP 状态代码：400
- ResourceNotFoundException
-
操作所需的资源不存在。
HTTP 状态代码：400
- ServiceUnavailableException
-
由于服务器发生临时故障而导致请求失败。
HTTP 状态代码：500
另请参阅
有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：
