CreateLegalHold - AWS Backup

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

CreateLegalHold

对恢复点(备份)创建合法保留。法定保留是在授权用户取消法定保留之前对更改或删除备份的限制。如果恢复点上有一个或多个有效的法定保留,则任何删除或解除关联恢复点的操作都将失败并出现错误。

请求语法

POST /legal-holds/ HTTP/1.1 Content-type: application/json { "Description": "string", "IdempotencyToken": "string", "RecoveryPointSelection": { "DateRange": { "FromDate": number, "ToDate": number }, "ResourceIdentifiers": [ "string" ], "VaultNames": [ "string" ] }, "Tags": { "string" : "string" }, "Title": "string" }

URI请求参数

该请求不使用任何URI参数。

请求正文

该请求接受以下JSON格式的数据。

Description

对法律封存的描述。

类型:字符串

必需:是

IdempotencyToken

这是用户选择的字符串,用于区分原本相同的调用。使用相同的幂等性令牌重试成功的请求会生成一条成功消息,而不执行任何操作。

类型:字符串

必需:否

RecoveryPointSelection

分配一组资源(例如资源类型或备份存储库)的标准。

类型:RecoveryPointSelection 对象

必需:否

Tags

要包括的可选标签。标签是您可用来管理、筛选和搜索资源的键值对。允许的字符包括 UTF -8 个字母、数字、空格和以下字符:+-=。_:/。

类型:字符串到字符串映射

必需:否

Title

合法封存的标题。

类型:字符串

必需:是

响应语法

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

响应元素

如果操作成功,服务将发回 HTTP 200 响应。

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

CreationDate

法定封存的创建时间。

类型:时间戳

Description

对法律封存的描述。

类型:字符串

LegalHoldArn

合法封存的亚马逊资源名称 (ARN)。

类型:字符串

LegalHoldId

合法封存的 ID。

类型:字符串

RecoveryPointSelection

分配给一组资源(例如资源类型或备份存储库)的标准。

类型:RecoveryPointSelection 对象

Status

合法封存的状态。

类型:字符串

有效值:CREATING | ACTIVE | CANCELING | CANCELED

Title

合法封存的标题。

类型:字符串

错误

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

InvalidParameterValueException

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

HTTP状态码:400

LimitExceededException

已超过请求中的限制;例如,请求中允许的最大项目数。

HTTP状态码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP状态码:400

ServiceUnavailableException

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

HTTP状态码:500

另请参阅

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