CreateLocationSmb - AWS DataSync

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

CreateLocationSmb

为可以访问传输的服务器消息块(SMB)文件服务器创建AWS DataSync可以访问的服务器消息块(SMB)文件服务器的端点。有关更多信息,请参阅创建 SMB 项。

请求语法

{ "AgentArns": [ "string" ], "Domain": "string", "MountOptions": { "Version": "string" }, "Password": "string", "ServerHostname": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "User": "string" }

请求参数

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

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

AgentArns

指定DataSync要连接到 SMB 文件服务器的一个或多个代理。您可以使用代理的 Amazon 资源名称(ARN)指定代理项。

类型:字符串数组

数组成员:最少 1 项。最多项项项项项项项项项项。

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

模式:^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

必需:是

Domain

指定您的 SMB 文件服务器所属的 Windows 域名称。

有关更多信息,请参阅 SMB 的必需权限

类型:字符串

最大度度度度度度限制:最大度度度度度度度度度

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

必需:否

MountOptions

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

类型:SmbMountOptions 对象

必需:否

Password

指定可以挂载要挂载 SMB 文件服务器的用户的密码。

有关更多信息,请参阅 SMB 的必需权限

类型:字符串

最大度度度度度度限制:最大度度度度度度度

模式:^.{0,104}$

必需:是

ServerHostname

指定要挂载DataSync代理的 SMB 文件服务器的域名服务(DNS)服务(DNS)地址。

注意

您无法指定 IP 版本 6(IPv6)地址。

类型:字符串

长度限制:最大长度为 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 共享并访问其所有数据。有关更多信息,请参阅 SMB 的必需权限

类型:字符串

最大度度度度度度限制:最大度度度度度度度度度

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

必需:是

Tags

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

类型:TagListEntry 对象数组

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

必需:否

User

指定可以装载 SMB 文件服务器并有权访问传输中涉及的文件和文件夹的用户名。

有关为您的转移选择具有正确访问权限级别的用户的信息,请参阅 SMB 地点所需的权限

类型:字符串

最大度度度度度度限制:最大度度度度度度度

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

必需:是

响应语法

{ "LocationArn": "string" }

响应元素

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

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

LocationArn

您创建的 SMB 的 ARN。

类型:字符串

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

模式:^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

错误

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

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

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: