翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # GetSearchJob このオペレーションは、検索ジョブの進行状況を含むメタデータを取得します。 ## リクエストの構文 ``` GET /search-jobs/SearchJobIdentifier HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [SearchJobIdentifier](#API_BKS_GetSearchJob_RequestSyntax) ** 検索ジョブを指定する必須の一意の文字列。必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "CompletionTime": number, "CreationTime": number, "CurrentSearchProgress": { "ItemsMatchedCount": number, "ItemsScannedCount": number, "RecoveryPointsScannedCount": number }, "EncryptionKeyArn": "string", "ItemFilters": { "EBSItemFilters": [ { "CreationTimes": [ { "Operator": "string", "Value": number } ], "FilePaths": [ { "Operator": "string", "Value": "string" } ], "LastModificationTimes": [ { "Operator": "string", "Value": number } ], "Sizes": [ { "Operator": "string", "Value": number } ] } ], "S3ItemFilters": [ { "CreationTimes": [ { "Operator": "string", "Value": number } ], "ETags": [ { "Operator": "string", "Value": "string" } ], "ObjectKeys": [ { "Operator": "string", "Value": "string" } ], "Sizes": [ { "Operator": "string", "Value": number } ], "VersionIds": [ { "Operator": "string", "Value": "string" } ] } ] }, "Name": "string", "SearchJobArn": "string", "SearchJobIdentifier": "string", "SearchScope": { "BackupResourceArns": [ "string" ], "BackupResourceCreationTime": { "CreatedAfter": number, "CreatedBefore": number }, "BackupResourceTags": { "string" : "string" }, "BackupResourceTypes": [ "string" ], "SourceResourceArns": [ "string" ] }, "SearchScopeSummary": { "TotalItemsToScanCount": number, "TotalRecoveryPointsToScanCount": number }, "Status": "string", "StatusMessage": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CompletionTime](#API_BKS_GetSearchJob_ResponseSyntax) ** 検索ジョブが完了した日時 (Unix 形式および協定世界時 (UTC))。`CompletionTime` の値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ ** [CreationTime](#API_BKS_GetSearchJob_ResponseSyntax) ** 検索ジョブが作成された日時 (Unix 時刻形式および協定世界時 (UTC))。`CompletionTime` の値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ ** [CurrentSearchProgress](#API_BKS_GetSearchJob_ResponseSyntax) ** BackupsScannedCount、ItemsScanned、ItemsMatched を表す数値を返します。型: [CurrentSearchProgress](API_BKS_CurrentSearchProgress.md) オブジェクト ** [EncryptionKeyArn](#API_BKS_GetSearchJob_ResponseSyntax) ** 指定された検索ジョブの暗号化キー。例えば、`arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` などです。タイプ: 文字列 ** [ItemFilters](#API_BKS_GetSearchJob_ResponseSyntax) ** Item Filters は、検索の作成時に指定されたすべての入力項目プロパティを表します。型: [ItemFilters](API_BKS_ItemFilters.md) オブジェクト ** [Name](#API_BKS_GetSearchJob_ResponseSyntax) ** 指定された検索ジョブの名前を返します。タイプ: 文字列 ** [SearchJobArn](#API_BKS_GetSearchJob_ResponseSyntax) ** 指定された検索ジョブの Amazon リソースネーム (ARN) を識別する一意の文字列。タイプ: 文字列 ** [SearchJobIdentifier](#API_BKS_GetSearchJob_ResponseSyntax) ** 指定された検索ジョブを識別する一意の文字列。タイプ: 文字列 ** [SearchScope](#API_BKS_GetSearchJob_ResponseSyntax) ** 検索スコープは、検索に入力されるすべてのバックアッププロパティです。型: [SearchScope](API_BKS_SearchScope.md) オブジェクト ** [SearchScopeSummary](#API_BKS_GetSearchJob_ResponseSyntax) ** 以下を含む、指定された検索ジョブスコープの概要を返します。 + TotalBackupsToScanCount、検索によって返された復旧ポイントの数。 + TotalItemsToScanCount、検索によって返された項目の数。型: [SearchScopeSummary](API_BKS_SearchScopeSummary.md) オブジェクト ** [Status](#API_BKS_GetSearchJob_ResponseSyntax) ** 指定された検索ジョブの現在のステータス。検索ジョブのステータスは、`RUNNING`、`COMPLETED`、`STOPPED`、`FAILED`、`TIMED_OUT`、`EXPIRED` のいずれかです。型: 文字列有効な値：`RUNNING | COMPLETED | STOPPING | STOPPED | FAILED` ** [StatusMessage](#API_BKS_GetSearchJob_ResponseSyntax) ** ステータスメッセージは、ステータスが `ERRORED` の検索ジョブまたはステータスが `COMPLETED` で問題のあるジョブいずれかに対して返されます。例えば、アクセス許可の問題により、検索にスキャンできない復旧ポイントが含まれているというメッセージが表示される場合があります。タイプ: 文字列 ## エラーすべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。 ** 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 SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backupsearch-2018-05-10/GetSearchJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/GetSearchJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/GetSearchJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/GetSearchJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/GetSearchJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/GetSearchJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/GetSearchJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/GetSearchJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/GetSearchJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/GetSearchJob)