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

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

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 (Amazon Resource Number)。

类型:字符串

LegalHoldId

为恢复点的指定法定保留而返回的法定保留 ID。

类型:字符串

RecoveryPointSelection

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

类型:RecoveryPointSelection 对象

Status

这将显示创建法定保留后返回的法定保留的状态。状态可以是 ACTIVEPENDINGCANCELEDCANCELINGFAILED

类型:字符串

有效值:CREATING | ACTIVE | CANCELING | CANCELED

Title

这是创建法定保留后返回的法定保留的字符串标题。

类型:字符串

错误

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

InvalidParameterValueException

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

HTTP 状态代码:400

LimitExceededException

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

HTTP 状态代码:400

MissingParameterValueException

表示缺少必需的参数。

HTTP 状态代码:400

ServiceUnavailableException

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

HTTP 状态代码:500

另请参阅

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