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.
Active un AWS DataSync agent que vous déployez dans votre environnement de stockage. Le processus d'activation associe l'agent à votre Compte AWS.
Si vous n'avez pas encore déployé d'agent, consultez la section Ai-je besoin d'un DataSync agent ?
Syntaxe de la requête
{
"ActivationKey": "string",
"AgentName": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcEndpointId": "string"
}Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.
Cette demande accepte les données suivantes au format JSON.
- ActivationKey
-
Spécifie la clé d'activation de votre DataSync agent. Si vous n'avez pas de clé d'activation, consultez la section Activation de votre agent.
Type : String
Contraintes de longueur : longueur maximale de 29.
Modèle :
[A-Z0-9]{5}(-[A-Z0-9]{5}){4}Obligatoire : oui
- AgentName
-
Spécifie le nom de votre agent. Nous vous recommandons de spécifier un nom dont vous vous souviendrez.
Type : String
Contraintes de longueur : Longueur minimum de 0. Longueur maximum de 256.
Modèle :
^[a-zA-Z0-9\s+=._:@/-]+$Obligatoire : non
- SecurityGroupArns
-
Spécifie le nom de ressource Amazon (ARN) du groupe de sécurité qui autorise le trafic entre votre agent et le point de terminaison du service VPC. Vous ne pouvez spécifier qu'un seul ARN.
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):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$Obligatoire : non
- SubnetArns
-
Spécifie l'ARN du sous-réseau où se trouve le point de terminaison de votre service VPC. Vous ne pouvez spécifier qu'un seul ARN.
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):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$Obligatoire : non
- Tags
-
Spécifie des étiquettes qui vous aident à classer, filtrer et rechercher vos AWS ressources. Nous vous recommandons de créer au moins un tag pour votre agent.
Type : tableau d’objets TagListEntry
Membres du tableau : nombre minimum de 0 élément. Nombre maximal de 50 éléments.
Obligatoire : non
- VpcEndpointId
-
Spécifie l'ID du point de terminaison du service VPC que vous utilisez. Par exemple, un identifiant de point de terminaison VPC ressemble à.
vpce-01234d5aff67890e1Important
Le point de terminaison du service VPC que vous utilisez doit inclure le nom du DataSync service (par exemple,
com.amazonaws.us-east-2.datasync).Type : chaîne
Modèle :
^vpce-[0-9a-f]{17}$Obligatoire : non
Syntaxe de la réponse
{
"AgentArn": "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.
- AgentArn
-
L'ARN de l'agent que vous venez d'activer. Utilisez cette ListAgentsopération pour renvoyer une liste d'agents dans votre Compte AWS et Région AWS.
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}:agent/agent-[0-9a-z]{17}$
Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs 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 active un DataSync agent.
{
"ActivationKey": "AAAAA-1AAAA-BB1CC-33333-EEEEE",
"AgentName": "MyAgent",
"Tags": [{
"Key": "Job",
"Value": "TransferJob-1"
}]
}Exemple de réponse
La réponse renvoie l'ARN de l'agent activé.
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3"
}consultez aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
