CreateLocationSmb - AWS DataSync

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateLocationSmb

読み取りまたは書き込みが可能なサーバーメッセージブロック (SMB) サーバー上のファイルシステムを定義します。

リクエストの構文

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

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下の JSON 形式のデータを受け入れます。

AgentArns

Simple Message Block (SMB) の場所に使用するエージェントの Amazon リソースネーム (ARN)。

Type: 文字列の配列

配列メンバ: 最小数は 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 ドメインの名前。

Type: 文字列

長さの制約: 最大長は 253 です。

パターン: ^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

必須: いいえ

MountOptions

で使用されるマウントオプション DataSync での SMB サーバーにアクセスします。

型: SmbMountOptions オブジェクト

必須: いいえ

Password

共有をマウントでき、SMB ファイル共有のファイルとフォルダにアクセスできるユーザーのパスワード。

Type: 文字列

長さの制約: 最大長は 104 です。

パターン: ^.{0,104}$

必須: はい

ServerHostname

SMB サーバーの名前。この値は、SMB サーバーの IP アドレスまたはドメインネームサービス (DNS) 名です。オンプレミスにインストールされたエージェントは、このホスト名を使用してネットワークに SMB サーバーをマウントします。

注記

この名前は、DNS に準拠しているか、IP バージョン 4 (IPv4) アドレスである必要があります。

Type: 文字列

長さの制約: 最大長は 255 です。

パターン: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$

必須: はい

Subdirectory

SMB ソースの場所からのデータの読み取り、または SMB 送信先へのデータの書き込みに使用される SMB ファイルシステム内のサブディレクトリ。SMB パスは、SMB サーバーによってエクスポートされたパス、あるいはそのパスのサブディレクトリにする必要があります。このパスは、他の SMB クライアントがネットワークでマウントできるようにする必要があります。

注記

Subdirectory はスラッシュで指定する必要があります。例えば、/path/to/folderです。

指定するフォルダのすべてのデータを転送するには、 DataSync に SMB 共有をマウントし、その共有内のすべてのデータにアクセスするためのアクセス許可を持つことが必要です。そのためには、指定したユーザー/パスワードが、共有をマウントできるユーザー、および必要なすべてのファイルとディレクトリに対する適切なアクセス許可を持っているユーザーに属することを確認します。 DataSync にアクセスするか、Backup Operators グループのメンバーの認証情報を使用して共有をマウントします。いずれの場合も、エージェントはデータにアクセスできるようになります。エージェントがディレクトリにアクセスするため、さらにすべての実行アクセスを有効にする必要があります。

Type: 文字列

長さの制約: 最大長は 4096 です。

パターン: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$

必須: はい

Tags

場所に追加するタグを表すキーと値のペア。値は空の文字列とすることができます。タグを使用してリソースに名前を付けることをお勧めします。

Type: 配列TagListEntryオブジェクト

配列メンバ: 最小項目数は 0 です。最大数は 50 項目です。

必須: いいえ

User

共有をマウントでき、SMB ファイル共有のファイルとフォルダにアクセスできるユーザー。

ファイル、フォルダ、およびメタデータに対する十分な権限を確保するユーザー名の選択については、ユーザー設定中小規模ビジネス拠点向け。

Type: 文字列

長さの制約: 最大長は 104 です。

パターン: ^[^\x5B\x5D\\/:;|=,+*?]{1,104}$

必須: はい

レスポンスの構文

{ "LocationArn": "string" }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

LocationArn

作成されたソース SMB ファイルシステムの場所の Amazon リソースネーム (ARN)。

Type: 文字列

長さの制約: 最大長は 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

この例で示すのは、 CreateLocationSmb。

リクエスト例

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

この例で示すのは、 CreateLocationSmb。

レスポンス例

{"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"}

以下の資料も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。