翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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 リソースネーム (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 を表します。型: タイムスタンプ
- CreatorRequestId
-
リクエストを識別するための一意の文字列で、失敗したリクエストを再試行する際に、オペレーションを2回実行するリスクを回避することができます。このパラメータはオプションです。使用する場合、このパラメータには 1～50 文字の英数字または「-_」を含める必要があります 。
型: 文字列
- 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 を表します。
型: タイムスタンプ
- Locked
-
AWS Backup ボールトロックが現在バックアップボールトを保護しているかどうかを示すブール値。 は、ボールトロックがボールトに保存されている復旧ポイントの削除または更新オペレーションを失敗させる
Trueことを意味します。型: ブール値
- MaxRetentionDays
-
AWS Backup ボールトが復旧ポイントを保持する最大保持期間を指定するボールトロック設定。このパラメータを指定しない場合、Vault Lock はボールト内のリカバリポイントに最大保持期間を強制しません (無期限ストレージを許可)。
指定した場合、ボールトへのバックアップジョブもしくはコピージョブには、保存期間が最大保存期間と同等もしくは以下のライフサイクル・ポリシーを持つ必要があります。ジョブの保持期間がその最大保存期間よりも長い場合、ボールトはバックアップジョブもしくはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。ボールトロックの前にボールトにすでに格納されているリカバリポイントは影響を受けません。
型: 長整数
- MinRetentionDays
-
AWS Backup ボールトが復旧ポイントを保持する最小保持期間を指定するボールトロック設定。このパラメータを指定しない場合、ボールトロックは最小保持期間を強制しません。
指定した場合、ボールトへのバックアップジョブまたはコピージョブには、最小保存期間以上の保存期間を持つライフサイクルポリシーが必要です。ジョブの保持期間がその最小保存期間より短い場合、ボールトはバックアップジョブまたはコピージョブに失敗するため、ライフサイクル設定を変更するか、別のボールトを使用する必要があります。ボールトロックの前にボールトにすでに格納されているリカバリポイントは影響を受けません。
型: 長整数
- NumberOfRecoveryPoints
-
バックアップボールトに保存されている復旧ポイントの数。
型: 長整数
- 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、以下を参照してください。
