ListBackupJobs - AWS Backup
リクエストの構文URI リクエストパラメータリクエスト本文レスポンスの構文レスポンス要素エラー以下の資料も参照してください。

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

ListBackupJobs

過去 30 日間の認証済みアカウントの既存のバックアップジョブのリストを返します。より長い期間については、これらの モニタリングツール を使用することを検討してください。

リクエストの構文

GET /backup-jobs/?accountId=ByAccountId&backupVaultName=ByBackupVaultName&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1

URI リクエストパラメータ

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

ByAccountId

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

AWS Organizations 管理アカウントから使用する場合、 を渡すと、組織全体のすべてのジョブ*が返されます。

パターン: ^[0-9]{12}$

ByBackupVaultName

指定したバックアップボールトに保存されるバックアップジョブのみを返します。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。

パターン: ^[a-zA-Z0-9\-\_]{2,50}$

ByCompleteAfter

Unix 形式と協定世界時 () で表された日付の後に完了したバックアップジョブのみを返しますUTC。

ByCompleteBefore

Unix 形式と協定世界時 () で表される日付より前に完了したバックアップジョブのみを返しますUTC。

ByCreatedAfter

指定した日付より後に作成されたバックアップジョブのみを返します。

ByCreatedBefore

指定した日付より前に作成されたバックアップジョブのみを返します。

ByMessageCategory

これは、入力する値 MessageCategory と一致する を使用してジョブをフィルタリングするために使用できるオプションのパラメータです。

文字列の例としては AccessDenied、SUCCESS、AGGREGATE_ALL、および InvalidParameters があります。

「モニタリング」を参照してください。

ワイルドカード () はすべてのメッセージカテゴリの数を返します。

AGGREGATE_ALL は、すべてのメッセージカテゴリのジョブ数を集計し、その合計を返します。

ByParentJobId

親ジョブ ID に基づいて子 (ネストされた) ジョブを一覧表示するフィルターです。

ByResourceArn

指定されたリソース Amazon リソースネーム () に一致するバックアップジョブのみを返しますARN。

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

  • FSx Amazon 用 FSx

  • Amazon Neptune の場合 用の Neptune

  • Amazon Relational Database Service 用の RDS

  • Amazon Redshift 用の Redshift

  • S3 for Amazon Simple Storage Service (Amazon S3)

  • SAP HANA on Amazon EC2 Amazon Elastic Compute Cloud インスタンス上のSAPHANAデータベース用

  • Storage Gateway の AWS Storage Gateway

  • Amazon Timestream 用の Timestream

  • VirtualMachine VMware仮想マシン用

パターン: ^[a-zA-Z0-9\-\_\.]{1,50}$

ByState

指定された状態にあるバックアップジョブのみを返します。

Completed with issues は AWS Backup コンソールでのみ表示されるステータスです。の場合API、このステータスは の状態のジョブCOMPLETEDと、 以外の値MessageCategoryを持つ を指しますSUCCESS。つまり、ステータスは完了しますが、ステータスメッセージが表示されます。

のジョブ数を取得するにはCompleted with issues、2 つのGETリクエストを実行し、2 番目の小さい数を減算します。

GET /backup-jobs/?state=COMPLETED

GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED

有効な値: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

MaxResults

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

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

NextToken

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

リクエスト本文

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

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "BackupJobs": [ 
      { 
         "AccountId": "string",
         "BackupJobId": "string",
         "BackupOptions": { 
            "string" : "string" 
         },
         "BackupSizeInBytes": number,
         "BackupType": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "BytesTransferred": number,
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanVersion": "string",
            "BackupRuleId": "string"
         },
         "CreationDate": number,
         "ExpectedCompletionDate": number,
         "IamRoleArn": "string",
         "InitiationDate": number,
         "IsParent": boolean,
         "MessageCategory": "string",
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "StartBy": number,
         "State": "string",
         "StatusMessage": "string"
      }
   ],
   "NextToken": "string"
}

レスポンス要素

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

次のデータは、 サービスによって JSON 形式で返されます。

BackupJobs

JSON 形式で返されるバックアップジョブに関するメタデータを含む構造の配列。

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

NextToken

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

型: 文字列

エラー

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

InvalidParameterValueException

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

HTTP ステータスコード: 400

ServiceUnavailableException

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

HTTP ステータスコード: 500

以下の資料も参照してください。

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