翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # 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) ** `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。タイプ: 文字列 ** [BackupVaultName](#API_DescribeBackupVault_ResponseSyntax) ** バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先のリージョンに一意の名前で識別されます。タイプ: 文字列 ** [CreationDate](#API_DescribeBackupVault_ResponseSyntax) ** Unix 時刻形式および協定世界時 (UTC)で、バックアップボールトが作成された日時。`CreationDate`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ ** [CreatorRequestId](#API_DescribeBackupVault_ResponseSyntax) ** リクエストを識別するための一意の文字列で、失敗したリクエストを再試行する際に、オペレーションを2回実行するリスクを回避することができます。このパラメータはオプションです。使用する場合、このパラメータには 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、所有キーの場合は AWS\$1OWNED\$1KMS\$1KEY 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 ボールトロックが現在バックアップボールトを保護しているかどうかを示すブール値。は、ボールトロックがボールトに保存されている復旧ポイントの削除または更新オペレーションを失敗させる`True`ことを意味します。タイプ: ブール値 ** [MaxRetentionDays](#API_DescribeBackupVault_ResponseSyntax) ** AWS Backup ボールトが復旧ポイントを保持する最大保持期間を指定するボールトロック設定。このパラメータを指定しない場合、Vault Lock はボールト内のリカバリポイントに最大保持期間を強制しません (無期限ストレージを許可)。指定した場合、ボールトへのバックアップジョブもしくはコピージョブには、保存期間が最大保存期間と同等もしくは以下のライフサイクル・ポリシーを持つ必要があります。ジョブの保持期間がその最大保存期間よりも長い場合、ボールトはバックアップジョブもしくはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。ボールトロックの前にボールトにすでに格納されているリカバリポイントは影響を受けません。タイプ: Long ** [MinRetentionDays](#API_DescribeBackupVault_ResponseSyntax) ** AWS Backup ボールトが復旧ポイントを保持する最小保持期間を指定するボールトロック設定。このパラメータを指定しない場合、ボールトロックは最小保持期間を強制しません。指定した場合、ボールトへのバックアップジョブまたはコピージョブには、最小保存期間以上の保存期間を持つライフサイクルポリシーが必要です。ジョブの保持期間がその最小保存期間より短い場合、ボールトはバックアップジョブまたはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。ボールトロックの前にボールトにすでに格納されているリカバリポイントは影響を受けません。タイプ: Long ** [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 を使用します。タイプ: Long ** [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 ## その他の参照資料言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeBackupVault) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeBackupVault) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeBackupVault) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeBackupVault) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeBackupVault) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeBackupVault) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeBackupVault) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeBackupVault) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeBackupVault) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeBackupVault)