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.
DescribeStorageSystemResources
Renvoie les informations que DataSync Discovery collecte sur les ressources de votre système de stockage sur site.
Syntaxe de la requête
{
"DiscoveryJobArn": "string",
"Filter": {
"string" : [ "string" ]
},
"MaxResults": number,
"NextToken": "string",
"ResourceIds": [ "string" ],
"ResourceType": "string"
}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 données 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
- Filter
-
Filtre les ressources du système de stockage que vous souhaitez renvoyer. Il peut s'agir par exemple de volumes associés à une machine virtuelle de stockage (SVM) spécifique.
TYpe : mappage de chaîne à tableau de chaînes
Clés valides :
SVMContraintes de longueur : longueur maximum de 1 024.
Modèle :
^.{0,1024}$Obligatoire : non
- MaxResults
-
Spécifie le nombre maximum de ressources du système de stockage que vous souhaitez répertorier dans une 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 : Longueur : Longueur : longueur : Longueur : Longueur maximum maximum maximum maximum maximum
Modèle :
[a-zA-Z0-9=_-]+Obligatoire : non
- ResourceIds
-
Spécifie les identifiants uniques universels (UUID) des ressources du système de stockage sur lesquelles vous souhaitez obtenir des informations. Vous ne pouvez pas utiliser ce paramètre en combinaison avec ce
Filterparamètre.Type : tableau de chaînes
Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 100 éléments.
Modèle :
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}Obligatoire : non
- ResourceType
-
Spécifie le type de ressources du système de stockage sur lequel vous souhaitez obtenir des informations.
Type : String
Valeurs valides :
SVM | VOLUME | CLUSTERObligatoire : oui
Syntaxe de la réponse
{
"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"
}
]
}
}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.
- 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 : Longueur : Longueur : longueur : Longueur : Longueur maximum maximum maximum maximum maximum
Modèle :
[a-zA-Z0-9=_-]+ - ResourceDetails
-
Les informations collectées sur les ressources de votre système de stockage. Une réponse peut également inclure des recommandations AWS de service de stockage.
Pour plus d'informations, consultez les informations sur les ressources de stockage collectées par Discovery et les recommandations fournies par DataSync Discovery.
Type : objet ResourceDetails
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 les volumes d'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" }
Exemple de réponse
L'exemple de réponse suivant inclut des informations sur les volumes du système de stockage sur site, y compris des recommandations sur l'endroit où déplacer les données du volume AWS (comme Amazon FSx pour NetApp ONTAP ou 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" } ] } }
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 :
