ListRestoreJobs - AWS Backup

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

ListRestoreJobs

復旧プロセスの詳細を含め、保存されたリソースの復元 AWS Backup を開始したジョブのリストを返します。

リクエストの構文

GET /restore-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&resourceType=ByResourceType&restoreTestingPlanArn=ByRestoreTestingPlanArn&status=ByStatus HTTP/1.1

URI リクエストパラメータ

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

ByAccountId

ジョブを一覧表示するアカウント ID。指定されたアカウント ID に関連付けられた復元ジョブのみを返します。

Pattern: ^[0-9]{12}$

ByCompleteAfter

Unix 形式および協定世界時 (UTC) で表された日付の後に完了したコピージョブのみを返します。

ByCompleteBefore

Unix 形式および協定世界時 (UTC) で表される日付より前に完了したコピージョブのみを返します。

ByCreatedAfter

指定した日付より後に作成された復元ジョブのみを返します。

ByCreatedBefore

指定した日付より前に作成された復元ジョブのみを返します。

ByResourceType

このパラメータを追加すると、指定されたリソースの復元ジョブのみを返します。

  • Amazon Aurora の場合は Aurora

  • CloudFormation の AWS CloudFormation

  • Amazon DocumentDB (MongoDB 互換性) の場合は DocumentDB

  • Amazon DynamoDB 用の DynamoDB

  • Amazon Elastic Block Store 用の EBS

  • Amazon Elastic Compute Cloud 用の EC2

  • Amazon Elastic File System 用の EFS

  • Amazon FSx の場合 用の FSx

  • Amazon Neptune の場合は Neptune

  • Amazon Redshift の場合は Redshift

  • Amazon Relational Database Service の場合は RDS

  • SAP HANA データベースの場合は SAP HANA on Amazon EC2

  • Storage Gateway の AWS Storage Gateway

  • Amazon S3 の場合は S3

  • Amazon Timestream 用の Timestream

  • 仮想マシンの場合は VirtualMachine

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

ByRestoreTestingPlanArn

指定されたリソースの Amazon リソースネーム (ARN) に一致する復元テストジョブのみを返します。

ByStatus

指定されたジョブステータスに関連付けられた復元ジョブのみを返します。

有効な値:PENDING | RUNNING | COMPLETED | ABORTED | FAILED

MaxResults

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

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

NextToken

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

リクエスト本文

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

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "RestoreJobs": [ { "AccountId": "string", "BackupSizeInBytes": number, "CompletionDate": number, "CreatedBy": { "RestoreTestingPlanArn": "string" }, "CreatedResourceArn": "string", "CreationDate": number, "DeletionStatus": "string", "DeletionStatusMessage": "string", "ExpectedCompletionTimeMinutes": number, "IamRoleArn": "string", "PercentDone": "string", "RecoveryPointArn": "string", "RecoveryPointCreationDate": number, "ResourceType": "string", "RestoreJobId": "string", "Status": "string", "StatusMessage": "string", "ValidationStatus": "string", "ValidationStatusMessage": "string" } ] }

レスポンス要素

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

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

NextToken

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

型: 文字列

RestoreJobs

保存されたリソースをリストアするためのジョブに関する詳細情報を含むオブジェクトの配列。

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

エラー

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

InvalidParameterValueException

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

HTTP ステータスコード:400

MissingParameterValueException

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

HTTP ステータスコード:400

ResourceNotFoundException

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

HTTP ステータスコード:400

ServiceUnavailableException

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

HTTP ステータスコード:500

その他の参照資料

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