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

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

ListBackupJobSummaries

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

このリクエストは、該当するジョブの Region、Account、State、ResourceType、MessageCategory、StartTime、EndTime、および Count を含む概要を返します。

リクエストの構文

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 は、認証された組織内のすべてのアカウントのジョブ数を集計し、その合計を返します。

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

AggregationPeriod

返された結果の期間。

  • ONE_DAY – 過去 14 日間の 1 日ごとのジョブ数。

  • 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) データベースなど。

パターン: ^[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

有効な値：CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY

リクエスト本文

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

レスポンスの構文

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"
}

レスポンス要素

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

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

AggregationPeriod

返された結果の期間。

  • ONE_DAY – 過去 14 日間の 1 日ごとのジョブ数。

  • SEVEN_DAYS – 過去 7 日間の合計のジョブ数。

  • FOURTEEN_DAYS – 過去 14 日間の合計のジョブ数。

タイプ: 文字列

BackupJobSummaries

概要情報。

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

NextToken

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

タイプ: 文字列

エラー

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

InvalidParameterValueException

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

Context

Type

HTTP ステータスコード: 400

ServiceUnavailableException

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

Context

Type

HTTP ステータスコード: 500

その他の参照資料

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