本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # DescribeBackupVault 返回由其名称指定的备份保管库的相关元数据。 ## 请求语法 ``` GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [BackupVaultAccountId](#API_DescribeBackupVault_RequestSyntax) ** 指定备份保管库的账户 ID。 ** [backupVaultName](#API_DescribeBackupVault_RequestSyntax) ** 用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的 AWS 区域中是唯一的。是否必需：是 ## 请求体该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "BackupVaultArn": "string", "BackupVaultName": "string", "CreationDate": number, "CreatorRequestId": "string", "EncryptionKeyArn": "string", "EncryptionKeyType": "string", "LatestMpaApprovalTeamUpdate": { "ExpiryDate": number, "InitiationDate": number, "MpaSessionArn": "string", "Status": "string", "StatusMessage": "string" }, "LockDate": number, "Locked": boolean, "MaxRetentionDays": number, "MinRetentionDays": number, "MpaApprovalTeamArn": "string", "MpaSessionArn": "string", "NumberOfRecoveryPoints": number, "SourceBackupVaultArn": "string", "VaultState": "string", "VaultType": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [BackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) ** 唯一标识备份保管库的 Amazon 资源名称 (ARN)；例如，`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`。类型：字符串 ** [BackupVaultName](#API_DescribeBackupVault_ResponseSyntax) ** 用于存储备份的逻辑容器的名称。备份保管库的名称在创建它们的账户和创建它们的区域中是唯一的。类型：字符串 ** [CreationDate](#API_DescribeBackupVault_ResponseSyntax) ** 备份保管库的创建日期和时间，采用 Unix 时间格式和协调世界时 (UTC)。`CreationDate` 的值精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型：时间戳 ** [CreatorRequestId](#API_DescribeBackupVault_ResponseSyntax) ** 唯一字符串，用于标识请求并允许重试失败的请求，同时避免发生两次运行操作的风险。此参数为可选的。如果使用，则此参数必须包含 1 到 50 个字母数字或“-\$1.” 字符。类型：字符串 ** [EncryptionKeyArn](#API_DescribeBackupVault_ResponseSyntax) ** 用于保护备份的服务器端加密密钥；例如，`arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`。类型：字符串 ** [EncryptionKeyType](#API_DescribeBackupVault_ResponseSyntax) ** 用于备份保管库的加密密钥的类型。对于客户管理的密钥，有效值为 CUSTOMER\$1MANAGED\$1KMS\$1KEY，对于客户管理的密钥，有效值为 \$1OWNED\$1KMS\$1KEY。 AWS AWS 类型：字符串有效值：`AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY` ** [LatestMpaApprovalTeamUpdate](#API_DescribeBackupVault_ResponseSyntax) ** 此备份保管库的 MPA 审批团队关联信息的最新更新情况。类型：[LatestMpaApprovalTeamUpdate](API_LatestMpaApprovalTeamUpdate.md) 对象 ** [LockDate](#API_DescribeBackupVault_ResponseSyntax) ** 无法更改或删除 AWS Backup 文件库锁定配置的日期和时间。如果您在未指定锁定日期的情况下对保管库应用了保管库锁定，则可以随时更改任何保管库锁定设置，或从保管库中完全删除保管库锁定。该值采用 Unix 格式和协调世界时 (UTC)，精确到毫秒。例如，值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。类型：时间戳 ** [Locked](#API_DescribeBackupVault_ResponseSyntax) ** 一个布尔值，用于指示 AWS Backup Vault Lock 当前是否在保护备份存储库。 `True`意味着文件库锁定会导致对存储在保管库中的恢复点执行删除或更新操作失败。类型：布尔值 ** [MaxRetentionDays](#API_DescribeBackupVault_ResponseSyntax) ** AWS Backup 文件库锁定设置，用于指定文件库保留其恢复点的最大保留期。如果不指定此参数，则保管库锁定不会对保管库中的恢复点强制规定最长保留期（允许无限期存储）。如果指定了此参数，则备份或复制到保管库的任何作业都必须具有生命周期策略，其保留期等于或小于最长保留期。如果作业的保留期长于该最长保留期，则保管库将无法执行该备份或复制作业，因此您应该修改生命周期设置或使用其他保管库。保管库锁定之前已存储在保管库中的恢复点不受影响。类型：长整型 ** [MinRetentionDays](#API_DescribeBackupVault_ResponseSyntax) ** AWS Backup 文件库锁定设置，用于指定文件库保留其恢复点的最短保留期。如果未指定此参数，保管库锁定将不会强制规定最短保留期。如果指定了此参数，则备份或复制到保管库的任何作业都必须具有生命周期策略，其保留期等于或大于最短保留期。如果作业的保留期短于该最短保留期，则保管库将无法执行该备份或复制作业，因此，您应该修改生命周期设置或使用其他保管库。保管库锁定之前已存储在保管库中的恢复点不受影响。类型：长整型 ** [MpaApprovalTeamArn](#API_DescribeBackupVault_ResponseSyntax) ** 与该备份保管库相关联的 MPA 审批团队的 ARN。类型：字符串 ** [MpaSessionArn](#API_DescribeBackupVault_ResponseSyntax) ** 与该备份保管库相关联的 MPA 会话的 ARN。类型：字符串 ** [NumberOfRecoveryPoints](#API_DescribeBackupVault_ResponseSyntax) ** 存储在备份保管库中的恢复点数量。控制台中显示的恢复点计数值可能是近似值。使用 [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html) API 来获取确切的计数。类型：长整型 ** [SourceBackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) ** 创建此恢复访问权限备份保管库所依据的源备份保管库的 ARN。类型：字符串 ** [VaultState](#API_DescribeBackupVault_ResponseSyntax) ** 保管库的当前状态。-> 类型：字符串有效值：`CREATING | AVAILABLE | FAILED` ** [VaultType](#API_DescribeBackupVault_ResponseSyntax) ** 所描述的保管库类型。类型：字符串有效值：`BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT` ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误类型](CommonErrors.md)。 ** InvalidParameterValueException ** 表示参数的值有问题。例如，该值超出了范围。 ** Context ** ** Type ** HTTP 状态代码：400 ** MissingParameterValueException ** 表示缺少必需的参数。 ** Context ** ** Type ** HTTP 状态代码：400 ** ResourceNotFoundException ** 该操作所需的资源不存在。 ** Context ** ** Type ** HTTP 状态代码：400 ** ServiceUnavailableException ** 由于服务器发生临时故障而导致请求失败。 ** Context ** ** Type ** HTTP 状态代码：500 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeBackupVault) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeBackupVault) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeBackupVault) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeBackupVault) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeBackupVault) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeBackupVault) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeBackupVault) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeBackupVault) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeBackupVault) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeBackupVault)