DescribeRestoreJob - Amazon Backup
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DescribeRestoreJob

返回与由作业 ID 指定的还原作业关联的元数据。

请求语法

GET /restore-jobs/restoreJobId HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

restoreJobId

唯一标识还原恢复点的作业。

必需:是

请求体

该请求没有请求体。

响应语法

HTTP/1.1 200 Content-type: application/json { "AccountId": "string", "BackupSizeInBytes": number, "CompletionDate": number, "CreatedBy": { "RestoreTestingPlanArn": "string" }, "CreatedResourceArn": "string", "CreationDate": number, "DeletionStatus": "string", "DeletionStatusMessage": "string", "ExpectedCompletionTimeMinutes": number, "IamRoleArn": "string", "PercentDone": "string", "RecoveryPointArn": "string", "RecoveryPointCreationDate": number, "ResourceType": "string", "RestoreJobId": "string", "Status": "string", "StatusMessage": "string", "ValidationStatus": "string", "ValidationStatusMessage": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

AccountId

返回拥有还原作业的账户 ID。

类型:字符串

模式:^[0-9]{12}$

BackupSizeInBytes

还原资源的大小(以字节为单位)。

类型:长整型

CompletionDate

恢复点还原作业的完成日期和时间,采用 Unix 格式和协调世界时 (UTC)。CompletionDate 的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

类型:时间戳

CreatedBy

包含有关创建还原作业的标识信息。

类型:RestoreJobCreator 对象

CreatedResourceArn

唯一标识还原恢复点的资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于备份资源的资源类型。

类型:字符串

CreationDate

还原作业的创建日期和时间,采用 Unix 时间格式和协调世界时 (UTC)。CreationDate 的值精确到毫秒。例如,值 1516925490.087 表示 2018 年 1 月 26 日星期五上午 12:11:30.087。

类型:时间戳

DeletionStatus

这记录了还原测试生成的数据的状态。状态可以是 DeletingFailedSuccessful

类型:字符串

有效值:DELETING | FAILED | SUCCESSFUL

DeletionStatusMessage

这描述了还原作业的删除状态。

类型:字符串

ExpectedCompletionTimeMinutes

恢复点还原作业预计要花费的时间(以分钟为单位)。

类型:长整型

IamRoleArn

指定用于创建目标恢复点的 IAM 角色 ARN;例如,arn:aws:iam::123456789012:role/S3Access

类型:字符串

PercentDone

包含在查询作业状态时作业已完成的估计百分比。

类型:字符串

RecoveryPointArn

唯一标识恢复点的 ARN;例如,arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45

类型:字符串

RecoveryPointCreationDate

这是指定还原作业创建恢复点的日期。

类型:时间戳

ResourceType

返回与按资源类型列出的还原作业关联的元数据。

类型:字符串

模式:^[a-zA-Z0-9\-\_\.]{1,50}$

RestoreJobId

唯一标识还原恢复点的作业。

类型:字符串

Status

状态码,用于指定由 Amazon Backup 为还原恢复点而启动的作业的状态。

类型:字符串

有效值:PENDING | RUNNING | COMPLETED | ABORTED | FAILED

StatusMessage

一条显示恢复点还原作业状态的消息。

类型:字符串

ValidationStatus

这是针对指定还原作业运行的验证的状态。

类型:字符串

有效值:FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING

ValidationStatusMessage

这描述了针对指定的还原作业运行的验证的状态。

类型:字符串

错误

有关所有操作返回的常见错误的信息,请参阅常见错误

DependencyFailureException

依赖的 Amazon 服务或资源向 Amazon Backup 服务返回了错误,操作无法完成。

HTTP 状态代码:500

InvalidParameterValueException

表示参数的值有问题。例如,该值超出了范围。

HTTP 状态代码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码:400

ResourceNotFoundException

该操作所需的资源不存在。

HTTP 状态代码:400

ServiceUnavailableException

由于服务器发生临时故障而导致请求失败。

HTTP 状态代码:500

另请参阅

有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: