DescribeStorageSystemResources - AWS DataSync
请求语法请求参数响应语法响应元素错误示例另请参阅

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

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

筛选要返回的存储系统资源。例如，这可能是与特定存储虚拟机 (SVM) 关联的卷。

类型：字符串到字符串数组映射

有效密钥：SVM

长度约束：最大长度为 1024。

模式：^.{0,1024}$

必需：否

MaxResults

指定要在响应中列出的存储系统资源的最大数量。

类型：整数

有效范围：最小值为 1。最大值为 100。

必需：否

NextToken

指定一个不透明的字符串，该字符串指示响应中下一个结果列表的开始位置。

类型：字符串

长度：最大长度度度度度度度度，最大长度度度度。

模式：[a-zA-Z0-9=_-]+

必需：否

ResourceIds

指定您想要了解的存储系统资源的通用唯一标识符 (UUID)。不能将此参数Resource Name Nesour Filter ce Name Name

类型：字符串数组

数组成员：最少 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,
            "ClusterName": "string",
            "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" ],
            "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,
            "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

不透明的字符串，表示响应中下一个结果列表的开始位置。

类型：字符串

长度：最大长度度度度度度度度，最大长度度度度。

模式：[a-zA-Z0-9=_-]+

ResourceDetails

收集的有关存储系统资源的信息。响应还可以包括AWS存储服务建议。

有关更多信息，请参阅 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（例如适用于 NetApp ONTAP 的 Amazon FSx 或 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 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：