ListBackupVaults - AWS Backup

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ListBackupVaults

リカバリポイントのストレージコンテナとその情報のリストを返します。

リクエストの構文

GET /backup-vaults/?maxResults=MaxResults&nextToken=NextToken&shared=ByShared&vaultType=ByVaultType HTTP/1.1

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

ByShared

このパラメータは、ボールトのリストを共有ボールトでソートします。

ByVaultType

このパラメータは、ボールトのリストをボールトタイプでソートします。

有効な値:BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT

MaxResults

返されるアイテムの最大数。

有効な範囲: 最小値 は 1 です。最大値は 1000 です。

NextToken

返された項目の一部リストに続く次の項目。たとえば、MaxResults アイテム数のリクエストが行われるようにされた場合、NextToken では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

リクエスト本文

リクエストにリクエスト本文がありません。

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "BackupVaultList": [ { "BackupVaultArn": "string", "BackupVaultName": "string", "CreationDate": number, "CreatorRequestId": "string", "EncryptionKeyArn": "string", "LockDate": number, "Locked": boolean, "MaxRetentionDays": number, "MinRetentionDays": number, "NumberOfRecoveryPoints": number } ], "NextToken": "string" }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

BackupVaultList

Amazon リソースネーム (ARN)、表示名、作成日、保存されたリカバリポイントの数、バックアップボールトに保存されているリソースが暗号化されている場合の暗号化情報など、ボールトメタデータを含むバックアップボールトリストメンバーの配列。

型: BackupVaultListMember オブジェクトの配列

NextToken

返された項目の一部リストに続く次の項目。たとえば、MaxResults アイテム数のリクエストが行われるようにされた場合、NextToken では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

型: 文字列

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InvalidParameterValueException

パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。

HTTP ステータスコード:400

MissingParameterValueException

必須パラメータがないことを示します。

HTTP ステータスコード:400

ResourceNotFoundException

アクションに必要なリソースは存在しません。

HTTP ステータスコード:400

ServiceUnavailableException

サーバーの一時的障害のため、リクエストは失敗しました。

HTTP ステータスコード:500

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。