CreateLocationSmb - AWS DataSync

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

CreateLocationSmb

為AWS DataSync可存取傳輸中存取的伺服器訊息區塊 (SMB) 檔案區塊 (SMB) 檔案伺服器建立端點。如需詳細資訊,請參閱建立 SMB 位置

請求語法

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

請求參數

如需有關所有動作共用之參數的資訊,請參閱一般參數

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

AgentArns

指定您要連線至 SMB 檔案伺服器的代DataSync理程式 (一或多個代理程式)。您可以使用其 Amazon Resource Name (ARN) 指定代理程式。

類型:字串陣列

陣列成員:項目數下限為 1。項目數上限為 4。

長度限制:長度上限為 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 位置的必要許可

類型:字串

長度上限:長度上限為 253。

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

必要:否

MountOptions

指定存取 SMB 檔案伺服器中存取 SMB 檔案伺服器的 SMB 通訊協定版本。DataSync

類型:SmbMountOptions 物件

必要:否

Password

指定可掛載 SMB 檔案和資料夾之使用者的密碼。

如需詳細資訊,請參閱 SMB 位置的必要許可

類型:字串

長度上限:長度上限為 104。

模式:^.{0,104}$

必要:是

ServerHostname

指定DataSync代理程式將掛載的 SMB 檔案伺服器的網域名稱服務 (DNS) 名稱或 IP 位址。

注意

您無法指定 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 位置的必要許可

類型:字串

長度上限:長度上限為 4096。

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

必要:是

Tags

指定可協助您分類、篩選和搜尋 AWS 資源的標籤。建議您為位置建立至少一個名稱標籤。

類型:TagListEntry 物件陣列

陣列成員:項目數下限為 0。項目數上限為 50。

必要:否

User

指定可掛載 SMB 檔案伺服器的使用者名稱,並具有存取傳輸中涉及之檔案和資料夾的權限。

如需為移轉作業選擇具有適當存取層級之使用者的詳細資訊,請參閱 SMB 位置所需的權限

類型:字串

長度上限:長度上限為 104。

模式:^[^\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 的詳細資訊,請參閱下列說明: