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.
DescribeAgent
Renvoie des métadonnées relatives à un AWS DataSync agent, telles que son nom, son type de point de terminaison et son état.
Syntaxe de la requête
{
"AgentArn": "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.
- AgentArn
-
Spécifie l'Amazon Resource Name (ARN) de l'DataSyncagent à décrire.
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}$Obligatoire : oui
Syntaxe de la réponse
{
"AgentArn": "string",
"CreationTime": number,
"EndpointType": "string",
"LastConnectionTime": number,
"Name": "string",
"PrivateLinkConfig": {
"PrivateLinkEndpoint": "string",
"SecurityGroupArns": [ "string" ],
"SubnetArns": [ "string" ],
"VpcEndpointId": "string"
},
"Status": "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.
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}$ - CreationTime
-
Heure à laquelle l'agent a été activé (c'est-à-dire créé dans votre compte).
Type : Timestamp
- EndpointType
-
Type de point de terminaison auquel votre agent est connecté. Si le point de terminaison est un point de terminaison VPC, l'agent n'est pas accessible sur l'Internet public.
Type : String
Valeurs valides :
PUBLIC | PRIVATE_LINK | FIPS - LastConnectionTime
-
Heure à laquelle l'agent s'est connecté pour la dernière foisDataSync.
Type : Timestamp
- Name
-
Le nom de l'agent.
Type : String
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 256.
Modèle :
^[a-zA-Z0-9\s+=._:@/-]+$ - PrivateLinkConfig
-
Le sous-réseau et le groupe de sécurité DataSync utilisés pour accéder à un point de terminaison VPC.
Type : objet PrivateLinkConfig
- Status
-
L'état de l'agent. Si l'état est EN LIGNE, l'agent est correctement configuré et peut être utilisé. L'état d'exécution est l'état d'exécution normal d'un agent. Si l'état est HORS LIGNE, la machine virtuelle de l'agent est éteinte ou l'agent est dans un état défectueux. Une fois que le problème qui a provoqué l'état non sain est résolu, l'agent retourne à l'état EN LIGNE.
Type : String
Valeurs valides :
ONLINE | OFFLINE
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
L'exemple suivant renvoie les informations relatives à l'agent spécifié dans l'exemple de demande.
Exemple de demande
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3"
}Exemple
Cet exemple illustre une utilisation deDescribeAgent.
Exemple de réponse
{
"AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3",
"CreationTime": "1532660733.39",
"LastConnectionTime": "1532660733.39",
"Name": "MyAgent",
"Status": "ONLINE"
}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 :
