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.
Renvoie des informations sur un AWS DataSync agent, telles que son nom, son type de point de terminaison de service et son statut.
Syntaxe de la requête
{
"AgentArn": "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.
- AgentArn
-
Spécifie le nom de ressource Amazon (ARN) de l' DataSync agent sur lequel vous souhaitez obtenir des informations.
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",
"Platform": {
"Version": "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é.
Type : Timestamp
- EndpointType
-
Type de point de terminaison de service auquel votre agent est connecté.
Type : String
Valeurs valides :
PUBLIC | PRIVATE_LINK | FIPS - LastConnectionTime
-
La dernière fois que l'agent a communiqué avec le DataSync service.
Type : Timestamp
- Name
-
Le nom de l'agent.
Type : String
Contraintes de longueur : Longueur minimum de 0. Longueur maximum de 256.
Modèle :
^[a-zA-Z0-9\s+=._:@/-]+$ - Platform
-
Les informations relatives à la plate-forme concernant l'agent, telles que le numéro de version.
Type : objet Platform
- PrivateLinkConfig
-
Configuration réseau utilisée par l'agent lors de la connexion à un point de terminaison de service VPC.
Type : objet PrivateLinkConfig
- Status
-
Le statut de l'agent.
-
Si le statut est défini
ONLINE, l'agent est correctement configuré et prêt à être utilisé. -
Si le statut est le cas
OFFLINE, cela signifie que l'agent a été hors de contact avec DataSync lui pendant cinq minutes ou plus. Cela peut se produire pour plusieurs raisons. Pour plus d'informations, voir Que dois-je faire si mon agent est hors ligne ?
Type : String
Valeurs valides :
ONLINE | OFFLINE -
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 renvoie des informations sur un agent spécifié dans une demande.
{
"AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0"
}Exemple de réponse
L'exemple de réponse suivant décrit un agent qui utilise un point de terminaison de service public.
{
"AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0",
"Name": "Data center migration agent",
"Status": "ONLINE",
"LastConnectionTime": "2022-10-17T17:21:35.540000+00:00",
"CreationTime": "2022-10-05T20:52:29.499000+00:00",
"EndpointType": "PUBLIC",
"Platform": {
"Version": "2"
}
}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 :
