ListSearchJobBackups - AWS Backup

ListSearchJobBackups

このオペレーションは、検索ジョブに含まれていたすべてのバックアップ (復旧ポイント) のリストをページ分割形式で返します。

検索結果に予想されるバックアップが表示されない場合は、このオペレーションを呼び出して、検索に含まれる各バックアップを表示できます。アクセス許可の問題により FAILED ステータスが原因で含まれていなかったバックアップは、ステータスメッセージとともに表示されます。

ステータスが ACTIVE のバックアップインデックスを持つ復旧ポイントのみが検索結果に含まれます。インデックスに他のステータスがある場合、そのステータスはステータスメッセージとともに表示されます。

リクエストの構文

GET /search-jobs/SearchJobIdentifier/backups?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI リクエストパラメータ

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

MaxResults

返されるリソースリストアイテムの最大数。

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

NextToken

検索ジョブに含まれる返されたバックアップの部分的なリストに続く次のアイテム。

例えば、MaxResults で指定した数のバックアップを返すリクエストが行われた場合、NextToken を使用すると、次のトークンが指す場所から開始してさらにリストの項目を返すことができます。

SearchJobIdentifier

検索ジョブを指定する一意の文字列。

必須: はい

リクエストボディ

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

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Results": [ { "BackupCreationTime": number, "BackupResourceArn": "string", "IndexCreationTime": number, "ResourceType": "string", "SourceResourceArn": "string", "Status": "string", "StatusMessage": "string" } ] }

レスポンス要素

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

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

NextToken

検索ジョブに含まれる返されたバックアップの部分的なリストに続く次のアイテム。

例えば、MaxResults で指定した数のバックアップを返すリクエストが行われた場合、NextToken を使用すると、次のトークンが指す場所から開始してさらにリストの項目を返すことができます。

タイプ: 文字列

Results

検索ジョブの結果を返した復旧ポイント

タイプ: SearchJobBackupsResult オブジェクトの配列

エラー

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

AccessDeniedException

このアクションを実行する十分なアクセス権限がありません。

message

このアクションを実行する十分なアクセス権限がありません。

HTTP ステータスコード: 403

InternalServerException

内部サーバーエラーが発生しました。リクエストを再実行します。

message

リクエストの処理中に予期しないエラーが発生しました。

retryAfterSeconds

秒数後に呼び出しを再試行します。

HTTP ステータスコード: 500

ResourceNotFoundException

このリクエストではリソースが見つかりませんでした。

ARN やタイプなどのリソース情報が正しく存在していることを確認し、リクエストを再試行してください。

message

リクエストが、存在しないリソースを参照しています。

resourceId

影響を受けるリソースの仮定識別子。

resourceType

影響を受けるリソースの仮定タイプ。

HTTP ステータスコード: 404

ThrottlingException

リクエストのスロットリングにより、リクエストが拒否されました。

message

リクエストのスロットリングにより、リクエストは失敗しました。

quotaCode

これは、クォータを持つ元のサービスに固有のコードです。

retryAfterSeconds

秒数後に呼び出しを再試行します。

serviceCode

これは、元のサービスに固有のコードです。

HTTP ステータスコード: 429

ValidationException

入力が、サービスで指定された制約を満たしていません。

message

入力が、Amazon サービスで指定された制約を満たしていません。

HTTP ステータスコード: 400

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

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