本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
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
-
创建合法封存时采用数字格式的时间。
类型:Timestamp
- Description
-
这是合法保全的返回字符串描述。
类型:字符串
- LegalHoldArn
-
这是创建的合法保全的 ARN(亚马逊资源编号)。
类型:字符串
- LegalHoldId
-
为恢复点上的指定合法保留返回了合法保留 ID。
类型:字符串
- RecoveryPointSelection
-
这指定了分配一组资源(例如资源类型或备份文件库)的标准。
类型:RecoveryPointSelection 对象
- Status
-
这将显示创建合法保全后返回的合法保全的状态。状态可以是
ACTIVE
PENDING
、CANCELED
CANCELING
、或FAILED
。类型:字符串
有效值:
CREATING | ACTIVE | CANCELING | CANCELED
- Title
-
这是创建合法保全后返回的合法保全的字符串标题。
类型:字符串
错误
有关所有操作常见错误的信息,请参阅常见错误。
- InvalidParameterValueException
-
表示参数的值有问题。例如,该值超出范围。
HTTP 状态代码:400
- LimitExceededException
-
已超过请求中的限制;例如,请求中允许的最大项目数。
HTTP 状态代码:400
- MissingParameterValueException
-
表示缺少必填参数。
HTTP 状态代码:400
- ServiceUnavailableException
-
由于服务器发生临时故障而导致请求失败。
HTTP 状态代码:500
另请参阅
有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: