ListScanJobs - AWS Backup

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

ListScanJobs

過去 30 日間の認証済みアカウントの既存のスキャンジョブのリストを返します。

リクエストの構文

GET /scan/jobs?ByAccountId=ByAccountId&ByBackupVaultName=ByBackupVaultName&ByCompleteAfter=ByCompleteAfter&ByCompleteBefore=ByCompleteBefore&ByMalwareScanner=ByMalwareScanner&ByRecoveryPointArn=ByRecoveryPointArn&ByResourceArn=ByResourceArn&ByResourceType=ByResourceType&ByScanResultStatus=ByScanResultStatus&ByState=ByState&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI リクエストパラメータ

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

ByAccountId

ジョブを一覧表示するアカウント ID。指定されたアカウント ID に関連付けられたバックアップジョブのみを返します。

AWS Organizations 管理アカウントから使用する場合、 を渡すと、組織全体のすべてのジョブ*が返されます。

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

ByBackupVaultName

指定されたバックアップボールトに保存されるスキャンジョブのみを返します。バックアップボールトは、作成に使用したアカウントと作成先の AWS リージョンに固有の名前で識別されます。

パターン: ^[a-zA-Z0-9\-\_\.]{2,50}$

ByCompleteAfter

Unix 形式と協定世界時 (UTC) で表された日付より後に完了したスキャンジョブのみを返します。

ByCompleteBefore

Unix 形式および協定世界時 (UTC) で表される日付より前に完了したバックアップジョブのみを返します。

ByMalwareScanner

指定されたマルウェアスキャナーのスキャンジョブのみを返します。現在、 は のみをサポートしていますGUARDDUTY

有効な値:GUARDDUTY

ByRecoveryPointArn

指定された復旧ポイントに対して実行されたスキャンジョブのみを返します。

ByResourceArn

指定されたリソース Amazon リソースネーム (ARN) に一致するスキャンジョブのみを返します。

ByResourceType

指定された復元テストプラン名で復元テスト選択を返します。

  • EBSfor Amazon Elastic Block Store

  • EC2for Amazon Elastic Compute Cloud

  • S3for Amazon Simple Storage Service (Amazon S3)

パターン: ^[a-zA-Z0-9\-\_\.]{1,50}$

有効な値:EBS | EC2 | S3

ByScanResultStatus

指定されたスキャン結果のスキャンジョブのみを返します。

  • THREATS_FOUND

  • NO_THREATS_FOUND

有効な値:NO_THREATS_FOUND | THREATS_FOUND

ByState

指定されたスキャンジョブ状態のスキャンジョブのみを返します。

有効な値:CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING

MaxResults

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

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

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

NextToken

返された項目の一部リストに続く次の項目。たとえば、MaxResults アイテム数のリクエストが行われるようにされた場合、NextToken では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

リクエスト本文

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

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ScanJobs": [ { "AccountId": "string", "BackupVaultArn": "string", "BackupVaultName": "string", "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "IamRoleArn": "string", "MalwareScanner": "string", "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "ScanBaseRecoveryPointArn": "string", "ScanId": "string", "ScanJobId": "string", "ScanMode": "string", "ScannerRoleArn": "string", "ScanResult": { "ScanResultStatus": "string" }, "State": "string", "StatusMessage": "string" } ] }

レスポンス要素

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

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

NextToken

返された項目の一部リストに続く次の項目。たとえば、MaxResults アイテム数のリクエストが行われるようにされた場合、NextToken では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

タイプ: 文字列

ScanJobs

JSON 形式で返されるスキャンジョブに関するメタデータを含む構造体の配列。

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

エラー

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

InvalidParameterValueException

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

Context

Type

HTTP ステータスコード: 400

ServiceUnavailableException

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

Context

Type

HTTP ステータスコード: 500

その他の参照資料

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