翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeBackupJob
指定された BackupJobId のバックアップジョブの詳細を返します。
リクエストの構文
GET /backup-jobs/backupJobId HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- backupJobId
-
リソースをバックアップ 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",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"ExpectedCompletionDate": number,
"IamRoleArn": "string",
"InitiationDate": number,
"IsParent": boolean,
"MessageCategory": "string",
"NumberOfChildJobs": number,
"ParentJobId": "string",
"PercentDone": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"StartBy": number,
"State": "string",
"StatusMessage": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- AccountId
-
バックアップジョブを所有するアカウント ID を返します。
タイプ: 文字列
パターン:
^[0-9]{12}$ - BackupJobId
-
リソースをバックアップ AWS Backup するための へのリクエストを一意に識別します。
タイプ: 文字列
- BackupOptions
-
バックアッププランまたはオンデマンドバックアップジョブの一部として指定されたオプションを表します。
型: 文字列から文字列へのマッピング
キーパターン:
^[a-zA-Z0-9\-\_\.]{1,50}$値パターン:
^[a-zA-Z0-9\-\_\.]{1,50}$ - BackupSizeInBytes
-
バックアップ (復旧ポイント) のサイズをバイト単位で指定します。
この値は、他の AWS サービスからデータ情報を AWS Backup プルするときに、リソースタイプに応じてレンダリングが異なる場合があります。例えば、返される値は の値を示す場合があり
0、これは予想される値とは異なる場合があります。リソースタイプ別の値の予想される動作は次のとおりです。
-
Amazon Aurora、Amazon DocumentDB、Amazon Neptune では、この値はオペレーション から入力されません
GetBackupJobStatus。 -
高度な機能を備えた Amazon DynamoDB の場合、この値は復旧ポイント (バックアップ) のサイズを参照します。
-
Amazon EC2 と Amazon EBS は、この値の一部として返されるボリュームサイズ (プロビジョンドストレージ) を表示します。Amazon EBS はバックアップサイズ情報を返しません。スナップショットサイズは、バックアップされた元のリソースと同じ値になります。
-
Amazon EFS の場合、この値はバックアップ中に転送されたデルタバイト数を指します。
-
Amazon FSx は、
GetBackupJobStatusFSx ファイルシステムの オペレーションからこの値を入力しません。 -
Amazon RDS インスタンスは として表示されます
0。 -
VMware を実行している仮想マシンの場合、この値は非同期ワークフローを介して に渡 AWS Backup されます。これは、この表示される値が実際のバックアップサイズを過小表す可能性があることを意味します。
型: 長整数
-
- BackupType
-
バックアップジョブに対して選択された実際のバックアップタイプを表します。たとえば、Windows ボリュームシャドウコピーサービス (VSS) バックアップが正常に実行された場合、
BackupTypeは"WindowsVSS"を返します。BackupTypeが空の場合、バックアップタイプは通常のバックアップでした。タイプ: 文字列
- BackupVaultArn
-
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVaultなどのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。タイプ: 文字列
- BackupVaultName
-
バックアップを保存する論理コンテナの名前。バックアップボールトは、これらのボールトを作成するために使用されたアカウントと作成先の AWS リージョンに一意の名前で識別されます。
タイプ: 文字列
パターン:
^[a-zA-Z0-9\-\_]{2,50}$ - BytesTransferred
-
ジョブステータスの照会時にバックアップボールトに転送されたバイト単位のサイズ。
型: 長整数
- ChildJobsInState
-
これにより、含まれている子 (ネストされた) バックアップジョブの統計が返されます。
タイプ: 文字列を long にマッピング
有効なキー:
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL - CompletionDate
-
Unix 形式および協定世界時 (UTC)で、バックアップジョブを作成するジョブが完了した日時。
CompletionDateの値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ
- CreatedBy
-
バックアップジョブの作成のために使用されるバックアッププランの
BackupPlanArn、BackupPlanId、BackupPlanVersion、およびBackupRuleIdを含むバックアップジョブの作成に関する識別情報が含まれます。型: RecoveryPointCreator オブジェクト
- CreationDate
-
Unix 時刻形式および協定世界時 (UTC)で、バックアップジョブが作成された日時。
CreationDateの値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ
- ExpectedCompletionDate
-
Unix 形式および協定世界時 (UTC)で、リソースをバックアップするジョブが完了すると予想される日時 。
ExpectedCompletionDateの値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ
- IamRoleArn
-
たとえば、
arn:aws:iam::123456789012:role/S3Accessなどのターゲットリカバリポイントの作成に使用する IAM ロール ARN を指定します。タイプ: 文字列
- InitiationDate
-
バックアップジョブが開始された日付。
タイプ: タイムスタンプ
- IsParent
-
これにより、バックアップジョブが親 (複合) ジョブであることを示すブール値が返されます。
型: ブール値
- MessageCategory
-
指定されたメッセージカテゴリのジョブ数。
文字列の例としては
AccessDenied、SUCCESS、AGGREGATE_ALL、およびINVALIDPARAMETERSがあります。使用可能な MessageCategory 文字列のリストについては、「モニタリング」を参照してください。タイプ: 文字列
- NumberOfChildJobs
-
これにより、子 (ネストされた) バックアップジョブの数が返されます。
型: 長整数
- ParentJobId
-
これにより、親 (複合) リソースのバックアップジョブ ID が返されます。
タイプ: 文字列
- PercentDone
-
ジョブのステータスが照会された時点でジョブが完了した推定パーセンテージが含まれます。
タイプ: 文字列
- RecoveryPointArn
-
たとえば、
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45などのリカバリポイントを一意に識別する ARN。タイプ: 文字列
- ResourceArn
-
保存済みのリソースを一意に識別する ARN。ARN の形式は、リソースタイプによって異なります。
タイプ: 文字列
- ResourceName
-
指定されたバックアップに属するリソースの一意ではない名前。
タイプ: 文字列
- ResourceType
-
バックアップする AWS リソースのタイプ。Amazon Elastic Block Store (Amazon EBS) ボリュームや Amazon Relational Database Service (Amazon RDS) データベースなど。
タイプ: 文字列
パターン:
^[a-zA-Z0-9\-\_\.]{1,50}$ - StartBy
-
バックアップジョブがキャンセルされる前に開始する必要がある時刻を Unix 形式および協定世界時 (UTC) で指定します。この値は、スケジュールされた時刻に開始ウィンドウを追加して計算されます。そのため、予定時刻が午後6時でスタートウィンドウが2時間であれば、
StartBy時刻は指定された日付の午後 8:00 になります。StartByの値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ
- State
-
バックアップジョブの現在の状態です。
型: 文字列
有効な値：
CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL - StatusMessage
-
リソースをバックアップするジョブのステータスを説明する詳細なメッセージ。
タイプ: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- DependencyFailureException
-
依存 AWS サービスまたはリソースが AWS Backup サービスにエラーを返したため、アクションを完了できません。
HTTP ステータスコード: 500
- InvalidParameterValueException
-
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。
HTTP ステータスコード: 400
- MissingParameterValueException
-
必須パラメータがないことを示します。
HTTP ステータスコード: 400
- ResourceNotFoundException
-
アクションに必要なリソースは存在しません。
HTTP ステータスコード: 400
- ServiceUnavailableException
-
サーバーの一時的障害のため、リクエストは失敗しました。
HTTP ステータスコード: 500
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
