

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

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

提供有关如何配置服务器消息块 (SMB) 文件服务器的 AWS DataSync 传输位置的详细信息。

## 请求语法
<a name="API_DescribeLocationSmb_RequestSyntax"></a>

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

## 请求参数
<a name="API_DescribeLocationSmb_RequestParameters"></a>

有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。

请求接受采用 JSON 格式的以下数据。

 ** [LocationArn](#API_DescribeLocationSmb_RequestSyntax) **   <a name="DataSync-DescribeLocationSmb-request-LocationArn"></a>
指定您想要了解的 SMB 位置的 Amazon 资源名称（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 AWS KMS key管理的密钥（例如 DataSync 用于访问特定存储位置的`Password`或`KerberosKeytab`）的配置信息。  
类型：[CmkSecretConfig](API_CmkSecretConfig.md) 对象

 ** [CreationTime](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CreationTime"></a>
创建 SMB 位置的时间。  
类型：时间戳

 ** [CustomSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CustomSecretConfig"></a>
描述客户管理的密钥的配置信息，例如用于访问特定存储位置的`Password`或`KerberosKeytab`，并 DataSync 使用客户托管 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托管密钥的配置信息，例如 DataSync 用于访问特定存储位置的`Password`或`KerberosKeytab`。 DataSync 使用默认 AWS托管的 KMS 密钥在中 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>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS Python 软件开发工具包](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) 