ListCopyJobSummaries - AWS Backup

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

ListCopyJobSummaries

このリクエストは、過去 30 日以内に作成または実行されたコピージョブのリストを取得します。AccountID 、State、 ResourceType MessageCategory、 AggregationPeriod MaxResults、または パラメータを含める NextToken と、結果をフィルタリングできます。

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

リクエストの構文

GET /audit/copy-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 日間の毎日のジョブ数。

  • SEVEN_DAYS - 過去 7 日間の集計ジョブ数。

  • FOURTEEN_DAYS - 過去 14 日間の集計ジョブ数。

有効な値: ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MaxResults

このパラメータは返されるアイテムの最大数を指定します。

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

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

MessageCategory

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

使用できる文字列の例として、AccessDeniedSuccessInvalidParameters があります。受け入れ可能な 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 は、すべての状態のジョブ数を集計し、その合計を返します。

有効な値: CREATED | RUNNING | ABORTING | ABORTED | COMPLETING | COMPLETED | FAILING | FAILED | PARTIAL | AGGREGATE_ALL | ANY

リクエスト本文

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

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "AggregationPeriod": "string", "CopyJobSummaries": [ { "AccountId": "string", "Count": number, "EndTime": number, "MessageCategory": "string", "Region": "string", "ResourceType": "string", "StartTime": number, "State": "string" } ], "NextToken": "string" }

レスポンス要素

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

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

AggregationPeriod

返された結果の期間。

  • ONE_DAY - 過去 14 日間の毎日のジョブ数。

  • SEVEN_DAYS - 過去 7 日間の集計ジョブ数。

  • FOURTEEN_DAYS - 過去 14 日間の集計ジョブ数。

型: 文字列

CopyJobSummaries

この戻り値には、リージョン、アカウント、状態 ResourceType、 MessageCategory StartTime、 EndTime、および含まれるジョブの数を含む概要が表示されます。

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

NextToken

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

型: 文字列

エラー

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

InvalidParameterValueException

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

HTTP ステータスコード: 400

ServiceUnavailableException

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

HTTP ステータスコード: 500

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

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