GetLegalHold - AWS Backup

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

GetLegalHold

此操作返回指定法定保留的详细信息。除元数据外,详细信息还包括 JSON 格式的法定保留的正文。

请求语法

GET /legal-holds/legalHoldId/ HTTP/1.1

URI 请求参数

请求使用以下 URI 参数。

legalHoldId

它是使用 GetLegalHold 所需的 ID。此唯一 ID 与具体的法定保留相关联。

必需:是

请求体

该请求没有请求正文。

响应语法

HTTP/1.1 200 Content-type: application/json { "CancelDescription": "string", "CancellationDate": number, "CreationDate": number, "Description": "string", "LegalHoldArn": "string", "LegalHoldId": "string", "RecoveryPointSelection": { "DateRange": { "FromDate": number, "ToDate": number }, "ResourceIdentifiers": [ "string" ], "VaultNames": [ "string" ] }, "RetainRecordUntil": number, "Status": "string", "Title": "string" }

响应元素

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

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

CancelDescription

描述移除法定保留的原因的字符串。

类型:字符串

CancellationDate

取消法定保留的时间。

类型:时间戳

CreationDate

创建法定保留的时间(以数字格式表示)。

类型:时间戳

Description

这是返回的法定保留的字符串描述。

类型:字符串

LegalHoldArn

这是针对指定法定保留返回的框架 ARN。唯一标识资源的 Amazon 资源名称 (ARN)。ARN 的格式取决于资源类型。

类型:字符串

LegalHoldId

这是与指定法定保留关联的返回的 ID。

类型:字符串

RecoveryPointSelection

这会指定分配一组资源的标准,例如资源类型或备份保管库。

类型:RecoveryPointSelection 对象

RetainRecordUntil

这是保留法定保留记录的日期和时间。

类型:时间戳

Status

这是法定保留的状态。状态可以是 ACTIVECREATINGCANCELEDCANCELING

类型:字符串

有效值:CREATING | ACTIVE | CANCELING | CANCELED

Title

这是法定保留的字符串标题。

类型:字符串

错误

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

InvalidParameterValueException

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

HTTP 状态代码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:400

ServiceUnavailableException

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

HTTP 状态代码:500

另请参阅

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