CreateLocationSmb - Amazon DataSync
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

CreateLocationSmb

为服务器消息块 (SMB) 文件服务器创建传输位置。 Amazon DataSync 可以将此位置用作传输数据的源或目的地。

在开始之前,请务必了解如何 DataSync 访问 SMB 文件服务器。有关更多信息,请参阅提供 DataSync 对 SMB 文件服务器的访问权限

请求语法

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

请求参数

有关所有操作的通用参数的信息,请参阅常用参数

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

AgentArns

指定 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

指定用于连接您的 DataSync SMB 文件服务器的身份验证协议。 DataSync 支持NTLM(默认)和KERBEROS身份验证。

有关更多信息,请参阅提供 DataSync 对 SMB 文件服务器的访问权限

类型:字符串

有效值:NTLM | KERBEROS

必需:否

CmkSecretConfig

指定用于访问特定 SMB 存储位置的 DataSync托管密钥的配置信息,可以是PasswordKerberosKeytabNTLM(分别是(默认 DataSync )和KERBEROS身份验证类型),该密钥由客户管理。 Amazon KMS key

当您在CreateLocationSmbRequest请求中包含此参数时,您仅提供 KMS 密钥 ARN。 DataSync 将此 KMS 密钥与KerberosKeytab您指定的Password或一起使用来创建存储位置访问凭证的 DataSync托管密钥。

确保该用户 DataSync 有权访问您指定的 KMS 密钥。

注意

您可以使用CmkSecretConfig(使用PasswordKerberosKeytab)或CustomSecretConfig(不带任何PasswordKerberosKeytab)为CreateLocationSmbRequest请求提供凭证。不要为同一个请求同时提供两个CmkSecretConfigCustomSecretConfig参数。

类型:CmkSecretConfig 对象

必需:否

CustomSecretConfig

指定客户管理的 Secrets Manager 密钥的配置信息,其中 SMB 存储位置凭据以纯文本(对于Password)或二进制(用于)存储在 Secrets Manager 中。KerberosKeytab此配置包括密钥 ARN,以及提供密钥访问权限的 IAM 角色的 ARN。

注意

可使用 CmkSecretConfig(带有 SasConfiguration)或 CustomSecretConfig(不带 SasConfiguration)为 CreateLocationSmbRequest 请求提供凭证。不要为同一个请求提供这两个参数。

类型:CustomSecretConfig 对象

必需:否

DnsIpAddresses

为您的 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

指定您的 SMB 文件服务器所属的 Windows 域名称。此参数仅在 AuthenticationType 设置为 NTLM 时适用。

如果您的环境中有多个域,则配置此参数可确保 DataSync 连接到正确的文件服务器。

类型:字符串

长度约束:最大长度为 253。

模式:^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

必需:否

KerberosKeytab

指定 Kerberos 密钥表(keytab)文件,其中包括 Kerberos 主体和加密密钥之间的映射。

为避免出现任务执行错误,请确保用于创建 keytab 文件的 Kerberos 主体与为 KerberosPrincipal 指定的内容完全匹配。

类型:Base64 编码的二进制数据对象

长度约束:最大长度为 65536。

必需:否

KerberosKrb5Conf

指定用于定义 Kerberos 领域配置的 Kerberos 配置文件(krb5.conf)。

该文件必须采用 base64 编码。如果您使用的是 Amazon CLI,则编码已为您完成。

类型:Base64 编码的二进制数据对象

长度约束:最大长度为 131072。

必需:否

KerberosPrincipal

指定 Kerberos 主体,即 Kerberos 领域中有权访问 SMB 文件服务器中文件、文件夹和文件元数据的身份。

Kerberos 主体可能看起来像 HOST/kerberosuser@MYDOMAIN.ORG

主体名称区分大小写。如果您为此参数指定的主体与您用于创建 keytab 文件的主体不完全匹配,则 DataSync 任务执行将失败。

类型:字符串

长度限制:最小长度为 1。最大长度为 256。

模式:^.+$

必需:否

MountOptions

指定用于访问您的 SMB 文件服务器的 DataSync SMB 协议的版本。

类型:SmbMountOptions 对象

必需:否

Password

指定可以挂载 SMB 文件服务器并有权限访问传输中涉及的文件和文件夹的用户的密码。此参数仅在 AuthenticationType 设置为 NTLM 时适用。

类型:字符串

长度约束:最大长度为 104。

模式:^.{0,104}$

必需:否

ServerHostname

指定您的 DataSync 代理所连接的 SMB 文件服务器的域名IPv4 或 IP 地址(或 IPv6)。

注意

如果使用的是 Kerberos 身份验证,则必须指定域名。

类型:字符串

长度限制:长度上限为 255。

模式:^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$

是否必需:是

Subdirectory

指定 SMB 文件服务器导出的共享的名称,该共享 DataSync将在其中读取或写入数据。您可以在共享路径中包含子目录(例如,‭/path/to/subdirectory)。确保网络中的其他 SMB 客户端也可以挂载此路径。

要复制子目录中的所有数据, DataSync 必须能够装载 SMB 共享并访问其所有数据。有关更多信息,请参阅提供 DataSync 对 SMB 文件服务器的访问权限

类型:字符串

长度约束:最大长度为 4096。

模式:^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$

是否必需:是

Tags

指定帮助您分类、筛选和搜索 Amazon 资源的标签。我们建议至少为您的位置创建一个名称标签。

类型:TagListEntry 对象数组

数组成员:最少 0 个物品。最多 50 项。

必需:否

User

指定可以挂载和访问 SMB 文件服务器中文件、文件夹和文件元数据的用户。此参数仅在 AuthenticationType 设置为 NTLM 时适用。

有关选择具有适当访问权限级别的用户进行传输的信息,请参阅提供对 SMB 文件服务器的 DataSync 访问权限

类型:字符串

长度约束:最大长度为 104。

模式:^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$

必需:否

响应语法

{ "LocationArn": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

LocationArn

您创建的 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}$

错误

有关所有操作的常见错误信息,请参阅 常见错误

InternalException

当 Amazon 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 的更多信息 Amazon SDKs,请参阅以下内容: