DescribeStorageSystemResources - AWS DataSync
AnforderungssyntaxAnfrageparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribeStorageSystemResources

Gibt Informationen zurück, die DataSync Discovery über Ressourcen in Ihrem lokalen Speichersystem sammelt.

Anforderungssyntax

{
   "DiscoveryJobArn": "string",
   "Filter": { 
      "string" : [ "string" ]
   },
   "MaxResults": number,
   "NextToken": "string",
   "ResourceIds": [ "string" ],
   "ResourceType": "string"
}

Anfrageparameter

Informationen zu den Parametern, die allen Aktionen gemeinsam sind, finden Sie unter Allgemeine Parameter.

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

DiscoveryJobArn

Gibt den Amazon-Ressourcennamen (ARN) des Erkennungsauftrags an, der Daten aus Ihrem lokalen Speichersystem sammelt.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge von 256.

Pattern: ^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}$

Erforderlich: Ja

Filter

Filtert die Speichersystemressourcen, die Sie zurückgeben möchten. Dies können beispielsweise Volumes sein, die einer bestimmten virtuellen Speichermaschine (SVM) zugeordnet sind.

Typ: Zeichenfolge zu Array von Zeichenfolgen-Mapping

Gültige Schlüssel: SVM

Längenbeschränkungen: Maximale Länge von 1 024.

Pattern: ^.{0,1024}$

Erforderlich: Nein

MaxResults

Gibt die maximale Anzahl von Speichersystemressourcen an, die Sie in einer Antwort auflisten möchten.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1. Maximalwert 100.

Required: No

NextToken

Gibt eine undurchsichtige Zeichenfolge an, die die Position angibt, an der die nächste Ergebnisliste in der Antwort beginnen soll.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge von 65535.

Pattern: [a-zA-Z0-9=_-]+

Erforderlich: Nein

ResourceIds

Gibt die Universally Unique Identifiers (UUIDs) der Speichersystemressourcen an, zu denen Sie Informationen benötigen. Sie können diesen Parameter nicht in Kombination mit dem Filter Parameter verwenden.

Typ: Zeichenfolge-Array

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 100 Elemente.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Erforderlich: Nein

ResourceType

Gibt an, zu welcher Art von Speichersystemressourcen Sie Informationen benötigen.

Typ: Zeichenfolge

Zulässige Werte: SVM | VOLUME | CLUSTER

Erforderlich: Ja

Antwortsyntax

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

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

NextToken

Die undurchsichtige Zeichenfolge, die die Position angibt, an der die nächste Ergebnisliste in der Antwort beginnen soll.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge von 65535.

Pattern: [a-zA-Z0-9=_-]+

ResourceDetails

Die gesammelten Informationen über die Ressourcen Ihres Speichersystems. Eine Antwort kann auch Empfehlungen zum AWS Speicherservice beinhalten.

Weitere Informationen finden Sie unter Speicherressourceninformationen, die von Discovery gesammelt wurden, und Empfehlungen von DataSync Discovery.

Typ: ResourceDetails Objekt

Fehler

Hinweise zu den Fehlern, die allen Aktionen gemeinsam sind, finden Sie unterHäufige Fehler.

InternalException

Diese Ausnahme wird ausgelöst, wenn ein Fehler im AWS DataSync Dienst auftritt.

HTTP Status Code: 500

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine fehlerhafte Anfrage sendet.

HTTP Status Code: 400

Beispiele

Beispielanforderung

Im folgenden Beispiel werden Informationen über Volumes in einem lokalen Speichersystem angefordert.

{
    "DiscoveryJobArn": "arn:aws:datasync:us-east-1:123456789012:system/storage-system-abcdef01234567890/job/discovery-job-12345678-90ab-cdef-0abc-021345abcdef6",
    "ResourceType": "VOLUME"
}

Beispielantwort

Die folgende Beispielantwort enthält Informationen über Volumes im lokalen Speichersystem, einschließlich Empfehlungen, wohin die Volume-Daten verschoben werden sollen AWS (wie Amazon FSx for NetApp ONTAP oder 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"
            }
        ]
    }
}

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: