ListRecoveryPointsByBackupVault
バックアップボールトに保存されている復旧ポイントの詳細情報を返します。
リクエストの構文
GET /backup-vaults/backupVaultName/recovery-points/?backupPlanId=ByBackupPlanId&backupVaultAccountId=BackupVaultAccountId&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&parentRecoveryPointArn=ByParentRecoveryPointArn&resourceArn=ByResourceArn&resourceType=ByResourceType HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- BackupVaultAccountId
-
このパラメータは、復旧ポイントのリストをアカウント ID でソートします。
パターン:
^[0-9]{12}$ - backupVaultName
-
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。
注記
サポートされているサービスが Backup を作成するときに、バックアップボールト名を使用できないことがあります。
パターン:
^[a-zA-Z0-9\-\_]{2,50}$必須: はい
- ByBackupPlanId
-
指定したバックアッププラン ID に一致するリカバリポイントのみを返します。
- ByCreatedAfter
-
指定されたタイムスタンプの後に作成されたリカバリポイントのみを返します。
- ByCreatedBefore
-
指定されたタイムスタンプの前に作成されたリカバリポイントのみを返します。
- ByParentRecoveryPointArn
-
これにより、指定された親 (複合) 復旧ポイントの Amazon リソースネーム (ARN) に一致する復旧ポイントのみを返します。
- ByResourceArn
-
指定されたリソースの Amazon リソースネーム (ARN) に一致する復旧ポイントのみを返します。
- ByResourceType
-
指定されたリソースタイプに一致する復旧ポイントのみを返します。
-
Amazon Aurora の場合は
Aurora -
CloudFormationの場合は AWS CloudFormation -
Amazon DocumentDB (MongoDB 互換性) の場合は
DocumentDB -
DynamoDBAmazon DynamoDB 用の -
EBSAmazon Elastic Block Store 用の -
EC2Amazon Elastic Compute Cloud 用の -
EFSAmazon Elastic File System 用の -
FSxAmazon FSx の場合 用の -
NeptuneAmazon Neptune の場合 用の -
RDSAmazon Relational Database Service 用の -
Amazon Redshift 用の
Redshift -
Amazon Simple Storage Service (Amazon S3) 用の
S3 -
Amazon Elastic Compute Cloud インスタンスでの SAP HANA データベース用の
SAP HANA on Amazon EC2 -
AWS Storage Gateway 用の
Storage Gateway -
Amazon Timestream 用の
Timestream -
VMware 仮想マシン用の
VirtualMachine
パターン:
^[a-zA-Z0-9\-\_\.]{1,50}$ -
- MaxResults
-
返されるアイテムの最大数。
有効な範囲: 最小値 は 1 です。最大値は 1000 です。
- NextToken
-
返された項目の一部リストに続く次の項目。たとえば、
MaxResultsアイテム数のリクエストが行われるようにされた場合、NextTokenでは、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。
リクエスト本文
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"RecoveryPoints": [
{
"BackupSizeInBytes": number,
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CalculatedLifecycle": {
"DeleteAt": number,
"MoveToColdStorageAt": number
},
"CompletionDate": number,
"CompositeMemberIdentifier": "string",
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanName": "string",
"BackupPlanVersion": "string",
"BackupRuleCron": "string",
"BackupRuleId": "string",
"BackupRuleName": "string",
"BackupRuleTimezone": "string"
},
"CreationDate": number,
"EncryptionKeyArn": "string",
"IamRoleArn": "string",
"IndexStatus": "string",
"IndexStatusMessage": "string",
"InitiationDate": number,
"IsEncrypted": boolean,
"IsParent": boolean,
"LastRestoreTime": number,
"Lifecycle": {
"DeleteAfterDays": number,
"MoveToColdStorageAfterDays": number,
"OptInToArchiveForSupportedResources": boolean
},
"ParentRecoveryPointArn": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"SourceBackupVaultArn": "string",
"Status": "string",
"StatusMessage": "string",
"VaultType": "string"
}
]
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- NextToken
-
返された項目の一部リストに続く次の項目。たとえば、
MaxResultsアイテム数のリクエストが行われるようにされた場合、NextTokenでは、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。タイプ: 文字列
- RecoveryPoints
-
バックアップボールトに保存された復旧ポイントに関する詳細情報を含むオブジェクトの配列。
タイプ: RecoveryPointByBackupVault オブジェクトの配列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterValueException
-
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。
- Context
- Type
HTTP ステータスコード: 400
- MissingParameterValueException
-
必須パラメータがないことを示します。
- Context
- Type
HTTP ステータスコード: 400
- ResourceNotFoundException
-
アクションに必要なリソースは存在しません。
- Context
- Type
HTTP ステータスコード: 400
- ServiceUnavailableException
-
サーバーの一時的障害のため、リクエストは失敗しました。
- Context
- Type
HTTP ステータスコード: 500
その他の参照資料
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
