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

AddStorageSystem

Crée une AWS ressource pour un système de stockage sur site sur lequel vous souhaitez que DataSync Discovery collecte des informations.

Syntaxe de la requête

{
   "AgentArns": [ "string" ],
   "ClientToken": "string",
   "CloudWatchLogGroupArn": "string",
   "Credentials": { 
      "Password": "string",
      "Username": "string"
   },
   "Name": "string",
   "ServerConfiguration": { 
      "ServerHostname": "string",
      "ServerPort": number
   },
   "SystemType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

AgentArns

Spécifie l'Amazon Resource Name (ARN) de l'DataSyncagent qui se connecte et lit depuis l'interface de gestion de votre système de stockage sur site.

Type : tableau de chaînes

Membres du tableau : nombre fixe de 1 élément.

Contraintes de longueur : Longueur maximum de 128.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

Obligatoire : oui

ClientToken

Spécifie un jeton client pour s'assurer que les requêtes associées à cette opération d'API sont idempotentes. Si vous ne spécifiez pas de jeton client, DataSync génère un pour vous automatiquement.

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

CloudWatchLogGroupArn

Spécifie l'ARN du groupe de CloudWatch journaux Amazon pour la surveillance et la journalisation des événements liés aux tâches de découverte.

Type : String

Contraintes de 562 maximum de 562.

Modèle : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$

Obligatoire : non

Credentials

Spécifie l'nom d'utilisateur et mot de passe pour accéder à l'interface de gestion de votre système de stockage sur site.

Type : objet Credentials

Obligatoire : oui

Name

Spécifie un nom familier pour votre système de stockage sur site.

Type : String

Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 256.

Modèle : ^[\p{L}\p{M}\p{N}\s+=._:@\/-]+$

Obligatoire : non

ServerConfiguration

Spécifie le nom du serveur et le port réseau requis pour se connecter à l'interface de gestion de votre système de stockage sur site.

Type : objet DiscoveryServerConfiguration

Obligatoire : oui

SystemType

Spécifie le type de système de stockage local sur lequel vous souhaitez que DataSync Discovery collecte des informations.

Note

DataSyncDiscovery prend actuellement en charge les systèmes NetApp de stockage attaché au tissu (FAS) et les systèmes FAS 100 % Flash (AFF) exécutant ONTAP 9.7 ou version ultérieure.

Type : String

Valeurs valides : NetAppONTAP

Obligatoire : oui

Tags

Spécifie des étiquettes qui vous aident à catégoriser, filtrer et rechercher vos ressources AWS. Nous vous recommandons de créer au moins une balise de nom pour votre système de stockage sur site.

Type : tableau d’objets TagListEntry

Membres du tableau : nombre minimum de 0 élément. Nombre maximal de 50 éléments.

Obligatoire : non

Syntaxe de la réponse

{
   "StorageSystemArn": "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.

StorageSystemArn

L'ARN du système de stockage sur site que vous pouvez utiliser avec DataSync Discovery.

Type : String

Contraintes de longueur : Longueur maximum de 128.

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}$

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 ajoute un système de stockage local à DataSync Discovery.

{
    "ServerConfiguration": {
        "ServerHostname": "172.16.0.0",
        "ServerPort": 443
    },
    "SystemType": "NetAppONTAP",
    "AgentArns": [
        "arn:aws:datasync:us-east-1:111222333444:agent/agent-012345abcde012345"
    ],
    "CloudWatchLogGroupArn": "arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync/discovery:*",
    "Tags": [
        {
            "Key": "Migration Plan",
            "Value": "1"
        }
    ],
    "Name": "MyOnPremStorage",
    "Credentials": {
        "Username": "admin",
        "Password": "1234"
    }
}

Exemple de réponse

Une réponse renvoie l'ARN du système de stockage sur site que vous venez d'ajouter à DataSync Discovery.

{
    "StorageSystemArn": "arn:aws:datasync:us-east-1:111222333444:system/storage-system-abcdef01234567890"
}

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 :