

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

# DescribeLocationSmb
<a name="API_DescribeLocationSmb"></a>

提供如何設定伺服器訊息區塊 (SMB) 檔案伺服器的 AWS DataSync 傳輸位置的詳細資訊。

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

```
{
   "LocationArn": "string"
}
```

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

如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。

請求接受採用 JSON 格式的下列資料。

 ** [LocationArn](#API_DescribeLocationSmb_RequestSyntax) **   <a name="DataSync-DescribeLocationSmb-request-LocationArn"></a>
指定您要取得資訊之 SMB 位置的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 128。  
模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`  
必要：是

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

```
{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CreationTime": number,
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "DnsIpAddresses": [ "string" ],
   "Domain": "string",
   "KerberosPrincipal": "string",
   "LocationArn": "string",
   "LocationUri": "string",
   "ManagedSecretConfig": { 
      "SecretArn": "string"
   },
   "MountOptions": { 
      "Version": "string"
   },
   "User": "string"
}
```

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

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

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

 ** [AgentArns](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-AgentArns"></a>
可與 SMB 檔案伺服器連線的 DataSync 代理程式 ARNs。  
類型：字串陣列  
陣列成員：項目數下限為 1。最多 8 個項目。  
長度限制：長度上限為 128。  
模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`

 ** [AuthenticationType](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-AuthenticationType"></a>
DataSync 用來連線至 SMB 檔案伺服器的身分驗證通訊協定。  
類型：字串  
有效值:`NTLM | KERBEROS` 

 ** [CmkSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CmkSecretConfig"></a>
描述 DataSync 受管秘密的組態資訊，例如 `KerberosKeytab` DataSync 使用客戶受管存取特定儲存位置的 `Password`或 AWS KMS key。  
類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件

 ** [CreationTime](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CreationTime"></a>
建立 SMB 位置的時間。  
類型：Timestamp

 ** [CustomSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CustomSecretConfig"></a>
說明客戶受管秘密的組態資訊，例如 DataSync 用來存取特定儲存位置`KerberosKeytab`的 `Password`或 ，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。  
類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件

 ** [DnsIpAddresses](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-DnsIpAddresses"></a>
SMB 檔案伺服器所屬之 DNS 伺服器的 IPv4 或 IPv6 地址。此元素只有在 `AuthenticationType` 設定為 時才適用`KERBEROS`。  
類型：字串陣列  
陣列成員：最多 2 個項目。  
長度限制：長度下限為 7。長度上限為 39。  
模式：`\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z`

 ** [Domain](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-Domain"></a>
SMB 檔案伺服器所屬的 Windows 網域名稱。此元素只有在 `AuthenticationType` 設定為 時才適用`NTLM`。  
類型：字串  
長度限制：長度上限為 253。  
模式：`^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`

 ** [KerberosPrincipal](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-KerberosPrincipal"></a>
有權存取 SMB 檔案伺服器中檔案、資料夾和檔案中繼資料的 Kerberos 主體。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`^.+$`

 ** [LocationArn](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-LocationArn"></a>
SMB 位置的 ARN。  
類型：字串  
長度限制：長度上限為 128。  
模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`

 ** [LocationUri](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-LocationUri"></a>
SMB 位置的 URI。  
類型：字串  
長度限制：長度上限為 4360。  
模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`

 ** [ManagedSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-ManagedSecretConfig"></a>
描述 DataSync 受管秘密的組態資訊，例如 `Password`或 DataSync 用來存取特定儲存位置`KerberosKeytab`的 。DataSync 使用預設受管 KMS AWS金鑰來加密此秘密 AWS Secrets Manager。  
類型：[ManagedSecretConfig](API_ManagedSecretConfig.md) 物件

 ** [MountOptions](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-MountOptions"></a>
DataSync 用來存取 SMB 檔案伺服器的 SMB 通訊協定版本。  
類型：[SmbMountOptions](API_SmbMountOptions.md) 物件

 ** [User](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-User"></a>
可掛載和存取 SMB 檔案伺服器中檔案、資料夾和檔案中繼資料的使用者。此元素只有在 `AuthenticationType` 設定為 時才適用`NTLM`。  
類型：字串  
長度限制：長度上限為 104。  
模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`

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

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

 ** InternalException **   
當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。  
HTTP 狀態碼：500

 ** InvalidRequestException **   
當用戶端提交格式不正確的請求時，會擲回此例外狀況。  
HTTP 狀態碼：400

## 範例
<a name="API_DescribeLocationSmb_Examples"></a>

### 範例
<a name="API_DescribeLocationSmb_Example_1"></a>

此範例說明 DescribeLocationSmb 的一個用途。

#### 請求範例
<a name="API_DescribeLocationSmb_Example_1_Request"></a>

```
{
  "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}
```

### 範例
<a name="API_DescribeLocationSmb_Example_2"></a>

此範例說明 DescribeLocationSmb 的一個用途。

#### 回應範例
<a name="API_DescribeLocationSmb_Example_2_Response"></a>

```
{
   "AgentArns":[
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-0bc3b3dc9bbc15145",
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-04b3fe3d261a18c8f"
   ],
   "CreationTime":"1532660733.39",
   "Domain":"AMAZON",
   "LocationArn":"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49",
   "LocationUri":"smb://hostname.amazon.com/share",
   "MountOptions":{
      "Version":"SMB3"
   },
   "User":"user-1"
}
```

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

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