本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # CreateLocationSmb 为服务器消息块 (SMB) 文件服务器创建传输*位置*。 AWS DataSync 可以将此位置用作传输数据的源或目的地。在开始之前，请务必了解如何 DataSync 访问 SMB 文件服务器。有关更多信息，请参阅[提供 DataSync 对 SMB 文件服务器的访问权限](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。 ## 请求语法 ``` { "AgentArns": [ "string" ], "AuthenticationType": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "DnsIpAddresses": [ "string" ], "Domain": "string", "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "MountOptions": { "Version": "string" }, "Password": "string", "ServerHostname": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "User": "string" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AgentArns](#API_CreateLocationSmb_RequestSyntax) ** 指定 DataSync 可以连接到 SMB 文件服务器的一个或多个代理。使用代理的 Amazon 资源名称 (ARN) 指定代理。类型：字符串数组数组成员：最少 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_CreateLocationSmb_RequestSyntax) ** 指定用于连接您的 DataSync SMB 文件服务器的身份验证协议。 DataSync 支持`NTLM`（默认）和`KERBEROS`身份验证。有关更多信息，请参阅[提供 DataSync 对 SMB 文件服务器的访问权限](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。类型：字符串有效值：`NTLM | KERBEROS` 必需：否 ** [CmkSecretConfig](#API_CreateLocationSmb_RequestSyntax) ** 指定用于访问特定 SMB 存储位置的 DataSync托管密钥的配置信息，可以是`Password`或 `KerberosKeytab``NTLM`（分别是（默认 DataSync ）和`KERBEROS`身份验证类型），该密钥由客户管理。 AWS KMS key 当您在`CreateLocationSmbRequest`请求中包含此参数时，您仅提供 KMS 密钥 ARN。 DataSync 将此 KMS 密钥与`KerberosKeytab`您指定的`Password`或一起使用来创建存储位置访问凭证的 DataSync托管密钥。确保该用户 DataSync 有权访问您指定的 KMS 密钥。有关更多信息，请参阅[使用使用自定义 AWS KMS key密钥加密的服务管理密钥](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)。您可以使用`CmkSecretConfig`（使用`Password`或`KerberosKeytab`）或`CustomSecretConfig`（不带任何`Password`和`KerberosKeytab`）为`CreateLocationSmbRequest`请求提供凭证。不要为同一个请求同时提供两个`CmkSecretConfig`和`CustomSecretConfig`参数。类型：[CmkSecretConfig](API_CmkSecretConfig.md) 对象必需：否 ** [CustomSecretConfig](#API_CreateLocationSmb_RequestSyntax) ** 指定客户管理的 Secrets Manager 密钥的配置信息，其中 SMB 存储位置凭据以纯文本（对于`Password`）或二进制（用于）存储在 Secrets Manager 中。`KerberosKeytab`此配置包括密钥 ARN，以及提供密钥访问权限的 IAM 角色的 ARN。有关更多信息，请参阅[使用您管理的密钥](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)。可使用 `CmkSecretConfig`（带有 `SasConfiguration`）或 `CustomSecretConfig`（不带 `SasConfiguration`）为 `CreateLocationSmbRequest` 请求提供凭证。不要为同一个请求提供这两个参数。类型：[CustomSecretConfig](API_CustomSecretConfig.md) 对象必需：否 ** [DnsIpAddresses](#API_CreateLocationSmb_RequestSyntax) ** 为您的 SMB 文件服务器所属的 DNS 服务器指定 IPv4 或 IPv6 地址。此参数仅在 `AuthenticationType` 设置为 `KERBEROS` 时适用。如果您的环境中有多个域，则配置此参数 DataSync 可确保连接到正确的 SMB 文件服务器。类型：字符串数组数组成员：最多 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_CreateLocationSmb_RequestSyntax) ** 指定您的 SMB 文件服务器所属的 Windows 域名称。此参数仅在 `AuthenticationType` 设置为 `NTLM` 时适用。如果您的环境中有多个域，则配置此参数可确保 DataSync 连接到正确的文件服务器。类型：字符串长度约束：最大长度为 253。模式：`^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` 必需：否 ** [KerberosKeytab](#API_CreateLocationSmb_RequestSyntax) ** 指定 Kerberos 密钥表（keytab）文件，其中包括 Kerberos 主体和加密密钥之间的映射。为避免出现任务执行错误，请确保用于创建 keytab 文件的 Kerberos 主体与为 `KerberosPrincipal` 指定的内容完全匹配。类型：Base64 编码的二进制数据对象长度约束：最大长度为 65536。必需：否 ** [KerberosKrb5Conf](#API_CreateLocationSmb_RequestSyntax) ** 指定用于定义 Kerberos 领域配置的 Kerberos 配置文件（`krb5.conf`）。该文件必须采用 base64 编码。如果您使用的是 AWS CLI，则编码已为您完成。类型：Base64 编码的二进制数据对象长度约束：最大长度为 131072。必需：否 ** [KerberosPrincipal](#API_CreateLocationSmb_RequestSyntax) ** 指定 Kerberos 主体，即 Kerberos 领域中有权访问 SMB 文件服务器中文件、文件夹和文件元数据的身份。 Kerberos 主体可能看起来像 `HOST/kerberosuser@MYDOMAIN.ORG`。主体名称区分大小写。如果您为此参数指定的主体与您用于创建 keytab 文件的主体不完全匹配，则 DataSync 任务执行将失败。类型：字符串长度限制：最小长度为 1。最大长度为 256。模式：`^.+$` 必需：否 ** [MountOptions](#API_CreateLocationSmb_RequestSyntax) ** 指定用于访问您的 SMB 文件服务器的 DataSync SMB 协议的版本。类型：[SmbMountOptions](API_SmbMountOptions.md) 对象必需：否 ** [Password](#API_CreateLocationSmb_RequestSyntax) ** 指定可以挂载 SMB 文件服务器并有权限访问传输中涉及的文件和文件夹的用户的密码。此参数仅在 `AuthenticationType` 设置为 `NTLM` 时适用。类型：字符串长度约束：最大长度为 104。模式：`^.{0,104}$` 必需：否 ** [ServerHostname](#API_CreateLocationSmb_RequestSyntax) ** 指定您的 DataSync 代理所连接的 SMB 文件服务器的域名IPv4 或 IP 地址（或 IPv6）。如果使用的是 Kerberos 身份验证，则必须指定域名。类型：字符串长度限制：长度上限为 255。模式：`^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$` 是否必需：是 ** [Subdirectory](#API_CreateLocationSmb_RequestSyntax) ** 指定 SMB 文件服务器导出的共享的名称，该共享 DataSync将在其中读取或写入数据。您可以在共享路径中包含子目录（例如，‭`/path/to/subdirectory`）。确保网络中的其他 SMB 客户端也可以挂载此路径。要复制子目录中的所有数据， DataSync 必须能够装载 SMB 共享并访问其所有数据。有关更多信息，请参阅[提供 DataSync 对 SMB 文件服务器的访问权限](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。类型：字符串长度约束：最大长度为 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 是否必需：是 ** [Tags](#API_CreateLocationSmb_RequestSyntax) ** 指定帮助您分类、筛选和搜索 AWS 资源的标签。我们建议至少为您的位置创建一个名称标签。类型：[TagListEntry](API_TagListEntry.md) 对象数组数组成员：最少 0 个物品。最多 50 项。必需：否 ** [User](#API_CreateLocationSmb_RequestSyntax) ** 指定可以挂载和访问 SMB 文件服务器中文件、文件夹和文件元数据的用户。此参数仅在 `AuthenticationType` 设置为 `NTLM` 时适用。有关选择具有适当访问权限级别的用户进行传输的信息，请参阅[提供对 SMB 文件服务器的 DataSync 访问权限](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。类型：字符串长度约束：最大长度为 104。模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` 必需：否 ## 响应语法 ``` { "LocationArn": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [LocationArn](#API_CreateLocationSmb_ResponseSyntax) ** 您创建的 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}$` ## 错误有关所有操作的常见错误信息，请参阅 [常见错误](CommonErrors.md)。 ** InternalException ** 当 AWS DataSync 服务中发生错误时，会引发此异常。 HTTP 状态代码：500 ** InvalidRequestException ** 当客户端提交格式错误的请求时，会引发此异常。 HTTP 状态代码：400 ## 示例 ### 示例请求以下示例为 SMB 文件服务器创建一个位置。 ``` { "AgentArns":[ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs", "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3" ], "Domain":"AMAZON", "MountOptions":{ "Version":"SMB3" }, "Password":"string", "ServerHostname":"MyServer.amazon.com", "Subdirectory":"share", "Tags":[ { "Key":"department", "Value":"finance" } ], "User":"user-1" } ``` ### 示例响应响应会返回您的 SMB 文件服务器的位置 ARN。 ``` { "LocationArn": "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49" } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationSmb) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationSmb) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationSmb) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationSmb) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationSmb) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationSmb) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationSmb) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationSmb) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationSmb) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationSmb)