2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS Support
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeStorageSystemResources
DataSync Discovery がオンプレミスストレージシステム内のリソースについて収集した情報を返します。
リクエストの構文
{
"DiscoveryJobArn": "string",
"Filter": {
"string" : [ "string" ]
},
"MaxResults": number,
"NextToken": "string",
"ResourceIds": [ "string" ],
"ResourceType": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- DiscoveryJobArn
-
オンプレミスストレージシステムからデータを収集する検出ジョブの Amazon リソースネーム (ARN) を指定します。
型: 文字列
長さの制限: 最大長は 256 です。
パターン:
^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}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$必須: はい
- Filter
-
返したいストレージシステムリソースをフィルタリングします。たとえば、特定の Storage Virtual Machine (SVM) に関連付けられているボリュームなどがこれに該当します。
タイプ: 文字列マップの配列への文字列
有効なキー:
SVM長さの制限: 最大長は 1,024 です。
パターン:
^.{0,1024}$必須: いいえ
- MaxResults
-
レスポンスに表示するストレージシステムリソースの最大数を指定します。
型: 整数
有効範囲: 最小値 は 1 最大値は 100 です。
必須: いいえ
- NextToken
-
レスポンス内の次の結果リストの開始位置を示す不透明な文字列を指定します。
型: 文字列
長さの制限: 最大長は 65,535 です。
パターン:
[a-zA-Z0-9=_-]+必須: いいえ
- ResourceIds
-
情報が必要なストレージシステムリソースのユニバーサルユニーク識別子 (UUID) を指定します。このパラメータをパラメータと組み合わせて使用することはできません。
Filter型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 100 項目です。
パターン:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}必須: いいえ
- ResourceType
-
情報が必要なストレージシステムリソースの種類を指定します。
タイプ: 文字列
有効な値:
SVM | VOLUME | CLUSTER必須: はい
レスポンスの構文
{
"NextToken": "string",
"ResourceDetails": {
"NetAppONTAPClusters": [
{
"CifsShareCount": number,
"ClusterBlockStorageLogicalUsed": number,
"ClusterBlockStorageSize": number,
"ClusterBlockStorageUsed": number,
"ClusterCloudStorageUsed": number,
"ClusterName": "string",
"LunCount": number,
"MaxP95Performance": {
"IopsOther": number,
"IopsRead": number,
"IopsTotal": number,
"IopsWrite": number,
"LatencyOther": number,
"LatencyRead": number,
"LatencyWrite": number,
"ThroughputOther": number,
"ThroughputRead": number,
"ThroughputTotal": number,
"ThroughputWrite": number
},
"NfsExportedVolumes": number,
"Recommendations": [
{
"EstimatedMonthlyStorageCost": "string",
"StorageConfiguration": {
"string" : "string"
},
"StorageType": "string"
}
],
"RecommendationStatus": "string",
"ResourceId": "string"
}
],
"NetAppONTAPSVMs": [
{
"CifsShareCount": number,
"ClusterUuid": "string",
"EnabledProtocols": [ "string" ],
"LunCount": number,
"MaxP95Performance": {
"IopsOther": number,
"IopsRead": number,
"IopsTotal": number,
"IopsWrite": number,
"LatencyOther": number,
"LatencyRead": number,
"LatencyWrite": number,
"ThroughputOther": number,
"ThroughputRead": number,
"ThroughputTotal": number,
"ThroughputWrite": number
},
"NfsExportedVolumes": number,
"Recommendations": [
{
"EstimatedMonthlyStorageCost": "string",
"StorageConfiguration": {
"string" : "string"
},
"StorageType": "string"
}
],
"RecommendationStatus": "string",
"ResourceId": "string",
"SvmName": "string",
"TotalCapacityProvisioned": number,
"TotalCapacityUsed": number,
"TotalLogicalCapacityUsed": number,
"TotalSnapshotCapacityUsed": number
}
],
"NetAppONTAPVolumes": [
{
"CapacityProvisioned": number,
"CapacityUsed": number,
"CifsShareCount": number,
"LogicalCapacityUsed": number,
"LunCount": number,
"MaxP95Performance": {
"IopsOther": number,
"IopsRead": number,
"IopsTotal": number,
"IopsWrite": number,
"LatencyOther": number,
"LatencyRead": number,
"LatencyWrite": number,
"ThroughputOther": number,
"ThroughputRead": number,
"ThroughputTotal": number,
"ThroughputWrite": number
},
"NfsExported": boolean,
"Recommendations": [
{
"EstimatedMonthlyStorageCost": "string",
"StorageConfiguration": {
"string" : "string"
},
"StorageType": "string"
}
],
"RecommendationStatus": "string",
"ResourceId": "string",
"SecurityStyle": "string",
"SnapshotCapacityUsed": number,
"SvmName": "string",
"SvmUuid": "string",
"VolumeName": "string"
}
]
}
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- NextToken
-
レスポンス内の次の結果リストの開始位置を示す不透明な文字列。
型: 文字列
長さの制限: 最大長は 65,535 です。
パターン:
[a-zA-Z0-9=_-]+ - ResourceDetails
-
ストレージシステムのリソースに関して収集された情報。回答には、AWSストレージサービスの推奨事項を含めることもできます。
詳細については、「Discovery が収集するストレージリソース情報」と「 DataSync Discovery が提供する推奨事項」を参照してください。
型: ResourceDetails オブジェクト
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalException
-
この例外は、AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
例
リクエスト例
次の例では、オンプレミスストレージシステム内のボリュームに関する情報をリクエストします。
{ "DiscoveryJobArn": "arn:aws:datasync:us-east-1:123456789012:system/storage-system-abcdef01234567890/job/discovery-job-12345678-90ab-cdef-0abc-021345abcdef6", "ResourceType": "VOLUME" }
レスポンス例
次の応答例には、ボリュームデータを移動する場所AWS（Amazon FSx for NetApp ONTAP や Amazon EFS など）に関する推奨事項など、オンプレミスストレージシステム内のボリュームに関する情報が含まれています。
{ "ResourceDetails": { "NetAppONTAPVolumes": [ { "VolumeName": "vol1", "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "CifsShareCount": 0, "SecurityStyle": "unix", "SvmUuid": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", "SvmName": "my-svm", "CapacityUsed": 409600, "CapacityProvisioned": 1099511627776, "LogicalCapacityUsed": 409600, "NfsExported": true, "SnapshotCapacityUsed": 573440, "MaxP95Performance": { "IopsRead": 251.0, "IopsWrite": 44.0, "IopsOther": 17.0, "IopsTotal": 345.0, "ThroughputRead": 2.06, "ThroughputWrite": 0.88, "ThroughputOther": 0.11, "ThroughputTotal": 2.17, "LatencyRead": 0.06, "LatencyWrite": 0.07, "LatencyOther": 0.13 }, "Recommendations": [ { "StorageType": "fsxOntap", "StorageConfiguration": { "StorageCapacityGB": "1024", "ProvisionedIOpsMode": "AUTOMATIC", "CapacityPoolGB": "0", "TotalIOps": "0", "DeploymentType": "Multi-AZ", "ThroughputCapacity": "128" }, "EstimatedMonthlyStorageCost": "410.0" }, { "StorageType": "efs", "StorageConfiguration": { "InfrequentAccessStorageGB": "1", "StandardStorageGB": "1", "InfrequentAccessRequests": "0", "ProvisionedThroughputMBps": "0", "PerformanceMode": "General Purpose", "ThroughputMode": "Bursting" }, "EstimatedMonthlyStorageCost": "1.0" } ], "RecommendationStatus": "COMPLETED" }, { "VolumeName": "root_vol", "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "CifsShareCount": 0, "SecurityStyle": "unix", "SvmUuid": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", "SvmName": "my-svm", "CapacityUsed": 462848, "CapacityProvisioned": 1073741824, "LogicalCapacityUsed": 462848, "NfsExported": true, "SnapshotCapacityUsed": 421888, "MaxP95Performance": { "IopsRead": 261.0, "IopsWrite": 53.0, "IopsOther": 23.0, "IopsTotal": 360.0, "ThroughputRead": 10.0, "ThroughputWrite": 2.0, "ThroughputOther": 4.0, "ThroughputTotal": 12.0, "LatencyRead": 0.25, "LatencyWrite": 0.3, "LatencyOther": 0.55 }, "Recommendations": [ { "StorageType": "fsxOntap", "StorageConfiguration": { "StorageCapacityGB": "1024", "ProvisionedIOpsMode": "AUTOMATIC", "CapacityPoolGB": "0", "TotalIOps": "0", "DeploymentType": "Multi-AZ", "ThroughputCapacity": "128" }, "EstimatedMonthlyStorageCost": "410.0" }, { "StorageType": "efs", "StorageConfiguration": { "InfrequentAccessStorageGB": "1", "StandardStorageGB": "1", "InfrequentAccessRequests": "0", "ProvisionedThroughputMBps": "0", "PerformanceMode": "General Purpose", "ThroughputMode": "Bursting" }, "EstimatedMonthlyStorageCost": "1.0" } ], "RecommendationStatus": "COMPLETED" } ] } }
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
