本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
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"
}
回應元素
如果動作成功,服務會傳回 200 HTTP 個回應。
服務會以 JSON 格式傳回下列資料。
- CreationDate
-
法務保存建立的時間。
類型:Timestamp
- Description
-
法務保存的說明。
類型:字串
- LegalHoldArn
-
法務保存的 Amazon Resource Name (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,請參閱下列內容: