DescribeStorageSystemResourceMetrics - AWS DataSync
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursExemplesVoir aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

DescribeStorageSystemResourceMetrics

Renvoie des informations, notamment des données de performances et d'utilisation de la capacité, que DataSync Discovery collecte à propos d'une ressource spécifique dans votre système de stockage local.

Syntaxe de la requête

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

Paramètres de demande

Pour plus d'informations sur les paramètres communs à toutes les actions, voir Paramètres communs.

Cette demande accepte les données suivantes au format JSON.

DiscoveryJobArn

Spécifie l'Amazon Resource Name (ARN) de la tâche de découverte qui collecte les informations de votre système de stockage sur site.

Type : String

Contraintes de longueur : longueur maximale de 256.

Modèle : ^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}$

Obligatoire : oui

EndTime

Spécifie une durée comprise dans la durée totale d'exécution de la tâche de découverte. Pour voir les informations collectées au cours d'une certaine période, utilisez ce paramètre avecStartTime.

Type : Timestamp

Obligatoire : non

MaxResults

Spécifie le nombre de résultats que vous souhaitez voir figurer dans la réponse.

Type : entier

Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.

Obligatoire : non

NextToken

Spécifie une chaîne opaque qui indique la position de début de la liste suivante de résultats dans la réponse.

Type : String

Contraintes de longueur : Longueur maximum de 65 535.

Modèle : [a-zA-Z0-9=_-]+

Obligatoire : non

ResourceId

Spécifie l'identifiant unique universel (UUID) de la ressource du système de stockage sur laquelle vous souhaitez obtenir des informations.

Type : String

Modèle : [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Obligatoire : oui

ResourceType

Spécifie le type de ressource du système de stockage sur lequel vous souhaitez obtenir des informations.

Type : String

Valeurs valides : SVM | VOLUME | CLUSTER

Obligatoire : oui

StartTime

Spécifie une durée comprise dans la durée totale d'exécution de la tâche de découverte. Pour voir les informations collectées au cours d'une certaine période, utilisez ce paramètre avecEndTime.

Type : Timestamp

Obligatoire : non

Syntaxe de la réponse

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

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

Metrics

Informations collectées par votre tâche de découverte concernant les ressources de votre système de stockage.

Type : tableau d’objets ResourceMetrics

NextToken

Chaîne opaque qui indique la position à laquelle commencer la liste suivante de résultats dans la réponse.

Type : String

Contraintes de longueur : Longueur maximum de 65 535.

Modèle : [a-zA-Z0-9=_-]+

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, reportez-vous à la sectionErreurs courantes.

InternalException

Cette exception est levée lorsqu'une erreur se produit dans le AWS DataSync service.

Code d'état HTTP : 500

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

Code d'état HTTP : 400

Exemples

Exemple de demande

L'exemple suivant demande des informations sur un volume dans un système de stockage sur site.

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

Exemple de réponse

L'exemple de réponse suivant inclut des informations sur les performances et la capacité du 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"
        }
    ]
}

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :