翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # DescribeBackupJob 指定された `BackupJobId` のバックアップジョブの詳細を返します。 ## リクエストの構文 ``` GET /backup-jobs/backupJobId HTTP/1.1 ``` ## URI リクエストパラメータリクエストでは、次の URI パラメータを使用します。 ** [backupJobId](#API_DescribeBackupJob_RequestSyntax) ** リソースをバックアップ AWS Backup するためのへのリクエストを一意に識別します。必須: はい ## リクエストボディリクエストにリクエスト本文がありません。 ## レスポンスの構文 ``` HTTP/1.1 200 Content-type: application/json { "AccountId": "string", "BackupJobId": "string", "BackupOptions": { "string" : "string" }, "BackupSizeInBytes": number, "BackupType": "string", "BackupVaultArn": "string", "BackupVaultName": "string", "BytesTransferred": number, "ChildJobsInState": { "string" : number }, "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanName": "string", "BackupPlanVersion": "string", "BackupRuleCron": "string", "BackupRuleId": "string", "BackupRuleName": "string", "BackupRuleTimezone": "string" }, "CreationDate": number, "EncryptionKeyArn": "string", "ExpectedCompletionDate": number, "IamRoleArn": "string", "InitiationDate": number, "IsEncrypted": boolean, "IsParent": boolean, "MessageCategory": "string", "NumberOfChildJobs": number, "ParentJobId": "string", "PercentDone": "string", "RecoveryPointArn": "string", "RecoveryPointLifecycle": { "DeleteAfterDays": number, "DeleteAfterEvent": "string", "MoveToColdStorageAfterDays": number, "OptInToArchiveForSupportedResources": boolean }, "ResourceArn": "string", "ResourceName": "string", "ResourceType": "string", "StartBy": number, "State": "string", "StatusMessage": "string", "VaultLockState": "string", "VaultType": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [AccountId](#API_DescribeBackupJob_ResponseSyntax) ** バックアップジョブを所有するアカウント ID を返します。タイプ: 文字列パターン: `^[0-9]{12}$` ** [BackupJobId](#API_DescribeBackupJob_ResponseSyntax) ** リソースをバックアップ AWS Backup するためのへのリクエストを一意に識別します。タイプ: 文字列 ** [BackupOptions](#API_DescribeBackupJob_ResponseSyntax) ** バックアッププランまたはオンデマンドバックアップジョブの一部として指定されたオプションを表します。型: 文字列から文字列へのマッピングキーパターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` 値パターン:`^[a-zA-Z0-9\-\_\.]{1,50}$` ** [BackupSizeInBytes](#API_DescribeBackupJob_ResponseSyntax) ** バックアップ (復旧ポイント) のサイズ (バイト単位)。この値は、他の AWS サービスからデータ情報を AWS Backup プルするときに、リソースタイプに応じてレンダリングが異なる場合があります。例えば、返される値は `0` を示す場合があり、これは予想される値とは異なる場合があります。リソースタイプ別の値の予想される動作を以下に示します。 + Amazon Aurora、Amazon DocumentDB、および Amazon Neptune では、この値はオペレーション `GetBackupJobStatus` から入力されません。 + 高度な機能を備えた Amazon DynamoDB の場合、この値は復旧ポイント (バックアップ) のサイズを示します。 + Amazon EC2 と Amazon EBS は、この値の一部として返されるボリュームサイズ (プロビジョンドストレージ) を表示します。Amazon EBS はバックアップサイズ情報を返しません。スナップショットサイズは、バックアップされた元のリソースと同じ値になります。 + Amazon EFS の場合、この値はバックアップ中に転送されたデルタバイト数を示します。 + Amazon EKS の場合、この値はネストされた EKS 復旧ポイントのサイズを参照します。 + Amazon FSx は、FSx ファイルシステムの `GetBackupJobStatus` オペレーションからこの値を入力しません。 + Amazon RDS インスタンスは `0` と表示されます。 + VMware を実行している仮想マシンの場合、この値は非同期ワークフローを介して AWS Backup に渡されます。これは、この表示される値が実際のバックアップサイズを過小表示する可能性があることを意味します。タイプ: Long ** [BackupType](#API_DescribeBackupJob_ResponseSyntax) ** バックアップジョブに対して選択された実際のバックアップタイプを表します。たとえば、Windows ボリュームシャドウコピーサービス (VSS) バックアップが正常に実行された場合、`BackupType` は `"WindowsVSS"` を返します。`BackupType`が空の場合、バックアップタイプは通常のバックアップでした。タイプ: 文字列 ** [BackupVaultArn](#API_DescribeBackupJob_ResponseSyntax) ** `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`などのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。タイプ: 文字列 ** [BackupVaultName](#API_DescribeBackupJob_ResponseSyntax) ** バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。タイプ: 文字列パターン: `^[a-zA-Z0-9\-\_]{2,50}$` ** [BytesTransferred](#API_DescribeBackupJob_ResponseSyntax) ** ジョブステータスの照会時にバックアップボールトに転送されたバイト単位のサイズ。タイプ: Long ** [ChildJobsInState](#API_DescribeBackupJob_ResponseSyntax) ** これにより、含まれている子 (ネストされた) バックアップジョブの統計が返されます。タイプ: 文字列を long にマッピング有効なキー: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL` ** [CompletionDate](#API_DescribeBackupJob_ResponseSyntax) ** Unix 形式および協定世界時 (UTC)で、バックアップジョブを作成するジョブが完了した日時。`CompletionDate`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ ** [CreatedBy](#API_DescribeBackupJob_ResponseSyntax) ** バックアップジョブの作成のために使用されるバックアッププランの`BackupPlanArn`、`BackupPlanId`、`BackupPlanVersion`、および`BackupRuleId`を含むバックアップジョブの作成に関する識別情報が含まれます。型: [RecoveryPointCreator](API_RecoveryPointCreator.md) オブジェクト ** [CreationDate](#API_DescribeBackupJob_ResponseSyntax) ** Unix 時刻形式および協定世界時 (UTC)で、バックアップジョブが作成された日時。`CreationDate`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ ** [EncryptionKeyArn](#API_DescribeBackupJob_ResponseSyntax) ** バックアップの暗号化に使用される KMS キーの Amazon リソースネーム (ARN)。これは、ボールト設定に応じて、カスタマーマネージドキーでも AWS マネージドキーでもかまいません。タイプ: 文字列 ** [ExpectedCompletionDate](#API_DescribeBackupJob_ResponseSyntax) ** Unix 形式および協定世界時 (UTC)で、リソースをバックアップするジョブが完了すると予想される日時。`ExpectedCompletionDate`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ ** [IamRoleArn](#API_DescribeBackupJob_ResponseSyntax) ** たとえば、`arn:aws:iam::123456789012:role/S3Access`などのターゲットリカバリポイントの作成に使用する IAM ロール ARN を指定します。タイプ: 文字列 ** [InitiationDate](#API_DescribeBackupJob_ResponseSyntax) ** バックアップジョブが開始された日付。タイプ: タイムスタンプ ** [IsEncrypted](#API_DescribeBackupJob_ResponseSyntax) ** バックアップが暗号化されているかどうかを示すブール値。のすべてのバックアップ AWS Backup は暗号化されますが、このフィールドは透明性のために暗号化ステータスを示します。タイプ: ブール値 ** [IsParent](#API_DescribeBackupJob_ResponseSyntax) ** これにより、バックアップジョブが親 (複合) ジョブであることを示すブール値が返されます。タイプ: ブール値 ** [MessageCategory](#API_DescribeBackupJob_ResponseSyntax) ** 指定されたメッセージカテゴリのジョブ数。文字列の例としては `AccessDenied`、`SUCCESS`、`AGGREGATE_ALL`、および `INVALIDPARAMETERS` があります。使用可能な MessageCategory 文字列のリストについては、「[モニタリング](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html)」を参照してください。タイプ: 文字列 ** [NumberOfChildJobs](#API_DescribeBackupJob_ResponseSyntax) ** これにより、子 (ネストされた) バックアップジョブの数が返されます。タイプ: Long ** [ParentJobId](#API_DescribeBackupJob_ResponseSyntax) ** これにより、親 (複合) リソースのバックアップジョブ ID が返されます。タイプ: 文字列 ** [PercentDone](#API_DescribeBackupJob_ResponseSyntax) ** ジョブのステータスが照会された時点でジョブが完了した推定パーセンテージが含まれます。タイプ: 文字列 ** [RecoveryPointArn](#API_DescribeBackupJob_ResponseSyntax) ** たとえば、`arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`などのリカバリポイントを一意に識別する ARN。タイプ: 文字列 ** [RecoveryPointLifecycle](#API_DescribeBackupJob_ResponseSyntax) ** 復旧ポイントがコールドストレージに移行するまでの期間、または削除されるまでの期間を日数で指定します。コールドストレージに移行するバックアップは、最低 90 日間コールドストレージに保存する必要があります。したがって、コンソール上での保持期間の設定は、コールドへの移行 (日数) 設定から 90 日長くする必要があります。バックアップがコールドに移行された後で、コールドへの移行 (日数) の設定を変更することはできません。コールドストレージに移行できるリソースタイプは、[Feature availability by resource](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource) table. AWS Backup ignores this expression for other resource types にリストされています。既存のライフサイクルと保持期間を削除し、復旧ポイントを無期限に保持するには、`MoveToColdStorageAfterDays` と `DeleteAfterDays` に -1 を指定します。型: [Lifecycle](API_Lifecycle.md) オブジェクト ** [ResourceArn](#API_DescribeBackupJob_ResponseSyntax) ** 保存済みのリソースを一意に識別する ARN。ARN の形式は、リソースタイプによって異なります。タイプ: 文字列 ** [ResourceName](#API_DescribeBackupJob_ResponseSyntax) ** 指定されたバックアップに属するリソースの一意ではない名前。タイプ: 文字列 ** [ResourceType](#API_DescribeBackupJob_ResponseSyntax) ** バックアップする AWS リソースのタイプ。Amazon Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。タイプ: 文字列パターン: `^[a-zA-Z0-9\-\_\.]{1,50}$` ** [StartBy](#API_DescribeBackupJob_ResponseSyntax) ** バックアップジョブがキャンセルされる前に開始する必要がある時刻を Unix 形式および協定世界時 (UTC) で指定します。この値は、スケジュールされた時刻に開始ウィンドウを追加して計算されます。そのため、予定時刻が午後6時でスタートウィンドウが2時間であれば、`StartBy`時刻は指定された日付の午後 8:00 になります。`StartBy`の値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ ** [State](#API_DescribeBackupJob_ResponseSyntax) ** バックアップジョブの現在の状態です。型: 文字列有効な値：`CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL` ** [StatusMessage](#API_DescribeBackupJob_ResponseSyntax) ** リソースをバックアップするジョブのステータスを説明する詳細なメッセージ。　タイプ: 文字列 ** [VaultLockState](#API_DescribeBackupJob_ResponseSyntax) ** バックアップボールトのロック状態。論理エアギャップボールトの場合、これはボールトがコンプライアンスモードでロックされているかどうかを示します。有効な値は、`LOCKED` および `UNLOCKED` です。タイプ: 文字列 ** [VaultType](#API_DescribeBackupJob_ResponseSyntax) ** 対象の復旧ポイントが保存されているバックアップボールトのタイプ。有効な値は、標準バックアップボールトの場合は `BACKUP_VAULT`、論理エアギャップボールトの場合は `LOGICALLY_AIR_GAPPED_BACKUP_VAULT` です。タイプ: 文字列 ## エラーすべてのアクションに共通のエラーについては、「[一般的なエラータイプ](CommonErrors.md)」を参照してください。 ** DependencyFailureException ** 依存 AWS サービスまたはリソースが AWS Backup サービスにエラーを返したため、アクションを完了できません。 ** Context ** ** Type ** HTTP ステータスコード: 500 ** InvalidParameterValueException ** パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** MissingParameterValueException ** 必須パラメータがないことを示します。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** ResourceNotFoundException ** アクションに必要なリソースは存在しません。 ** Context ** ** Type ** HTTP ステータスコード: 400 ** ServiceUnavailableException ** サーバーの一時的障害のため、リクエストは失敗しました。 ** Context ** ** Type ** HTTP ステータスコード: 500 ## その他の参照資料言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/DescribeBackupJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeBackupJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeBackupJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeBackupJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeBackupJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeBackupJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeBackupJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeBackupJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeBackupJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeBackupJob)