本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# GetLegalHold
<a name="API_GetLegalHold"></a>

此動作會傳回指定法務保存的詳細資訊。詳細資料是 JSON 格式的法務保存內文，並包括中繼資料。

## 請求語法
<a name="API_GetLegalHold_RequestSyntax"></a>

```
GET /legal-holds/legalHoldId/ HTTP/1.1
```

## URI 請求參數
<a name="API_GetLegalHold_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [legalHoldId](#API_GetLegalHold_RequestSyntax) **   <a name="Backup-GetLegalHold-request-uri-LegalHoldId"></a>
法務保存的 ID。  
必要：是

## 請求主體
<a name="API_GetLegalHold_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_GetLegalHold_ResponseSyntax"></a>

```
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"
}
```

## 回應元素
<a name="API_GetLegalHold_ResponseElements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

 ** [CancelDescription](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CancelDescription"></a>
移除法務保存的原因。  
類型：字串

 ** [CancellationDate](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CancellationDate"></a>
取消法務保存的時間。  
類型：Timestamp

 ** [CreationDate](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CreationDate"></a>
建立法務保存的時間。  
類型：Timestamp

 ** [Description](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-Description"></a>
法務保存的說明。  
類型：字串

 ** [LegalHoldArn](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-LegalHoldArn"></a>
指定法務保存的架構 ARN。ARN 的格式取決於資源類型。  
類型：字串

 ** [LegalHoldId](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-LegalHoldId"></a>
法務保存的 ID。  
類型：字串

 ** [RecoveryPointSelection](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-RecoveryPointSelection"></a>
指派一組資源的條件，例如資源類型或備份文件庫。  
類型：[RecoveryPointSelection](API_RecoveryPointSelection.md) 物件

 ** [RetainRecordUntil](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-RetainRecordUntil"></a>
保留法務保存記錄的日期和時間。  
類型：Timestamp

 ** [Status](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-Status"></a>
法務保存的狀態。  
類型：字串  
有效值:`CREATING | ACTIVE | CANCELING | CANCELED` 

 ** [Title](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-Title"></a>
法務保存的標題。  
類型：字串

## 錯誤
<a name="API_GetLegalHold_Errors"></a>

如需所有動作常見錯誤的資訊，請參閱[常見錯誤類型](CommonErrors.md)。

 ** InvalidParameterValueException **   
表示參數的值出現問題。例如，值超出範圍。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** MissingParameterValueException **   
表示缺少必要的參數。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ResourceNotFoundException **   
動作所需的資源不存在。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：400

 ** ServiceUnavailableException **   
由於伺服器發生臨時故障，請求失敗。    
 ** Context **   
  
 ** Type **   

HTTP 狀態碼：500

## 另請參閱
<a name="API_GetLegalHold_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/GetLegalHold) 
+  [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetLegalHold) 
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetLegalHold) 
+  [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetLegalHold) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetLegalHold) 
+  [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetLegalHold) 
+  [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetLegalHold) 
+  [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetLegalHold) 
+  [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetLegalHold) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetLegalHold)