DescribeStorageSystemResourceMetrics - 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.

DescribeStorageSystemResourceMetrics

Gibt Informationen zurück, einschließlich Leistungsdaten und Kapazitätsauslastung, die DataSync Discovery über eine bestimmte Ressource in Ihrem lokalen Speichersystem sammelt.

Anforderungssyntax

{
   "DiscoveryJobArn": "string",
   "EndTime": number,
   "MaxResults": number,
   "NextToken": "string",
   "ResourceId": "string",
   "ResourceType": "string",
   "StartTime": number
}

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 Entdeckungsauftrags an, der Informationen über Ihr lokales 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

EndTime

Gibt eine Zeit innerhalb der Gesamtdauer an, zu der der Discovery-Job ausgeführt wurde. Um Informationen anzuzeigen, die in einem bestimmten Zeitraum gesammelt wurden, verwenden Sie diesen Parameter mitStartTime.

Typ: Zeitstempel

Required: No

MaxResults

Gibt an, wie viele Ergebnisse die Antwort enthalten soll.

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 6035.

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

Erforderlich: Nein

ResourceId

Gibt den Universally Unique Identifier (UUID) der Speichersystemressource an, zu der Sie Informationen benötigen.

Typ: Zeichenfolge

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

Erforderlich: Ja

ResourceType

Gibt die Art der Speichersystemressource an, zu der Sie Informationen benötigen.

Typ: Zeichenfolge

Zulässige Werte: SVM | VOLUME | CLUSTER

Erforderlich: Ja

StartTime

Gibt eine Zeit innerhalb der Gesamtdauer an, zu der der Discovery-Job ausgeführt wurde. Um Informationen anzuzeigen, die in einem bestimmten Zeitraum gesammelt wurden, verwenden Sie diesen Parameter mitEndTime.

Typ: Zeitstempel

Required: No

Antwortsyntax

{
   "Metrics": [ 
      { 
         "Capacity": { 
            "LogicalUsed": number,
            "Provisioned": number,
            "Used": number
         },
         "P95Metrics": { 
            "IOPS": { 
               "Other": number,
               "Read": number,
               "Total": number,
               "Write": number
            },
            "Latency": { 
               "Other": number,
               "Read": number,
               "Write": number
            },
            "Throughput": { 
               "Other": number,
               "Read": number,
               "Total": number,
               "Write": number
            }
         },
         "ResourceId": "string",
         "ResourceType": "string",
         "Timestamp": number
      }
   ],
   "NextToken": "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.

Metrics

Die Details, die Ihr Discovery-Job über Ihre Speichersystemressource gesammelt hat.

Typ: Array von ResourceMetrics-Objekten

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 6035.

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

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 ein Volume 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",
    "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

Beispielantwort

Die folgende Beispielantwort enthält Leistungs- und Kapazitätsinformationen zum Volume.

{
    "Metrics": [
        {
            "Timestamp": "2023-01-10T13:54:11-05:00",
            "P95Metrics": {
                "IOPS": {
                    "Read": 251.0,
                    "Write": 44.0,
                    "Other": 17.0,
                    "Total": 345.0
                },
                "Throughput": {
                    "Read": 2.06,
                    "Write": 0.88,
                    "Other": 0.11,
                    "Total": 2.17
                },
                "Latency": {
                    "Read": 0.06,
                    "Write": 0.07,
                    "Other": 0.13
                }
            },
            "Capacity": {
                "Used": 409600,
                "Provisioned": 1099511627776
            },
            "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "ResourceType": "VOLUME"
        }
    ]
}

Weitere Informationen finden Sie unter:

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