2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS Support
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
AddStorageSystem
AWS DataSync Discoveryに情報を収集させたいオンプレミスストレージシステムのリソースを作成します。
リクエストの構文
{
"AgentArns": [ "string" ],
"ClientToken": "string",
"CloudWatchLogGroupArn": "string",
"Credentials": {
"Password": "string",
"Username": "string"
},
"Name": "string",
"ServerConfiguration": {
"ServerHostname": "string",
"ServerPort": number
},
"SystemType": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- AgentArns
-
DataSync オンプレミスストレージシステムの管理インターフェイスに接続して読み取るエージェントの Amazon リソースネーム (ARN) を指定します。指定できる ARN は 1 つだけです。
型: 文字列の配列
配列メンバー: 定数は 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}$必須: はい
- ClientToken
-
この API オペレーションによるリクエストが同一であることを確認するためのクライアントトークンを指定します。クライアントトークンを指定しない場合、 DataSync 自動的に生成されます。
型: 文字列
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}必須: はい
- CloudWatchLogGroupArn
-
検出ジョブイベントのモニタリングとロギングに使用する Amazon CloudWatch ロググループの ARN を指定します。
型: 文字列
長さの制限: 最大長は 562 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$必須: いいえ
- Credentials
-
オンプレミスストレージシステムの管理インターフェイスにアクセスするためのユーザー名とパスワードを指定します。
型: Credentials オブジェクト
必須: はい
- Name
-
オンプレミスストレージシステムの使い慣れた名前を指定します。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 256 です。
パターン:
^[\p{L}\p{M}\p{N}\s+=._:@\/-]+$必須: いいえ
- ServerConfiguration
-
オンプレミスストレージシステムの管理インターフェースへの接続に必要なサーバ名とネットワークポートを指定します。
型: DiscoveryServerConfiguration オブジェクト
必須: はい
- SystemType
-
DataSync Discovery に情報を収集させたいオンプレミスストレージシステムのタイプを指定します。
注記
DataSync Discovery は現在、 NetApp ONTAP 9.7 以降を実行しているファブリック接続ストレージ（FAS）システムとオールフラッシュ FAS（AFF）システムをサポートしています。
タイプ: 文字列
有効な値:
NetAppONTAP必須: はい
- Tags
-
AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。オンプレミスストレージシステムには少なくともネームタグを作成することをお勧めします。
型: TagListEntry オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 50 項目です。
必須: いいえ
レスポンスの構文
{
"StorageSystemArn": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- StorageSystemArn
-
Discovery で使用できるオンプレミスストレージシステムの ARN。 DataSync
型: 文字列
長さの制限: 最大長は 128 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalException
-
この例外は、AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
例
リクエスト例
次の例では、オンプレミスストレージシステムを Discovery に追加しています。 DataSync
{ "ServerConfiguration": { "ServerHostname": "172.16.0.0", "ServerPort": 443 }, "SystemType": "NetAppONTAP", "AgentArns": [ "arn:aws:datasync:us-east-1:111222333444:agent/agent-012345abcde012345" ], "CloudWatchLogGroupArn": "arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync/discovery:*", "Tags": [ { "Key": "Migration Plan", "Value": "1" } ], "Name": "MyOnPremStorage", "Credentials": { "Username": "admin", "Password": "1234" } }
レスポンス例
レスポンスは、Discovery DataSync に追加したオンプレミスストレージシステムの ARN を返します。
{ "StorageSystemArn": "arn:aws:datasync:us-east-1:111222333444:system/storage-system-abcdef01234567890" }
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
