リクエストの構文 URI リクエストパラメータリクエスト本文レスポンスの構文レスポンス要素エラーその他の参照資料

ListBackupJobSummaries

過去 30 日以内に作成または実行されたバックアップジョブの概要を求めるリクエストです。AccountID 、State、、 ResourceType MessageCategory、またはパラメータを含めて AggregationPeriod MaxResults、結果を NextToken フィルタリングできます。

このリクエストは、リージョン、アカウント、状態、 ResourceType MessageCategory、 StartTime EndTime、および含まれるジョブの数を含む概要を返します。

リクエストの構文


GET /audit/backup-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1

URI リクエストパラメータ

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

AccountId

指定されたアカウントのジョブ数を返します。

リクエストがメンバーアカウントまたは AWS Organizations の一部ではないアカウントから送信されると、リクエスタのアカウント内のジョブが返されます。

ルート、管理者、および委任された管理者アカウントでは、ANY の値を使用して、組織内のすべてのアカウントのジョブ数を返すことができます。

AGGREGATE_ALL は、認証された組織内のすべてのアカウントのジョブ数を集計し、その合計を返します。

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

AggregationPeriod

返された結果の期間。

ONE_DAY - 過去 14 日間の毎日のジョブ数。
SEVEN_DAYS - 過去 7 日間の集計ジョブ数。
FOURTEEN_DAYS - 過去 14 日間の集計ジョブ数。

有効な値：ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MaxResults

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

値は整数です。指定できる値の範囲は 1～500 です。

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

MessageCategory

このパラメータは、指定されたメッセージカテゴリのジョブ数を返します。

使用できる文字列の例として、AccessDenied、Success、InvalidParameters があります。受け入れられた MessageCategory 文字列のリストについては、「モニタリング」を参照してください。

値 ANY は、すべてのメッセージカテゴリの数を返します。

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

NextToken

返されるリソースの部分的リストに続く次の項目です。例えば、MaxResults の数のリソースを返すようにリクエストが行われた場合、NextToken を使用すると、このトークンが指す場所から開始してさらにリストの項目を返すことができます。

ResourceType

指定されたリソースタイプのジョブ数を返します。リクエスト GetSupportedResourceTypes を使用して、サポートされているリソースタイプの文字列を取得します。

値 ANY は、すべてのリソースタイプの数を返します。

AGGREGATE_ALL は、すべてのリソースタイプのジョブ数を集計し、その合計を返します。

バックアップする AWS リソースのタイプ。Amazon Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。

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

State

このパラメータは、指定された状態のジョブの数を返します。

値 ANY は、すべての状態の数を返します。

AGGREGATE_ALL は、すべての状態のジョブ数を集計し、その合計を返します。

Completed with issues は AWS Backup コンソールでのみ表示されるステータスです。API の場合このステータスは、状態が COMPLETED で MessageCategory の値が SUCCESS 以外のジョブ、つまり完了はしているがステータスメッセージがあるジョブを指します。Completed with issues のジョブ数を取得するには、以下のように GET リクエストを 2 回実行し、2 つ目の小さい方の数字を引きます。

GET /audit/backup-job-summaries？AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

GET /audit/backup-job-summaries？AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED

リクエスト本文

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

レスポンスの構文


HTTP/1.1 200
Content-type: application/json

{
   "AggregationPeriod": "string",
   "BackupJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MessageCategory": "string",
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ],
   "NextToken": "string"
}