

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

# DescribeAgent
<a name="API_DescribeAgent"></a>

Restituisce informazioni su un AWS DataSync agente, ad esempio il nome, il tipo di endpoint del servizio e lo stato.

## Sintassi della richiesta
<a name="API_DescribeAgent_RequestSyntax"></a>

```
{
   "AgentArn": "string"
}
```

## Parametri della richiesta
<a name="API_DescribeAgent_RequestParameters"></a>

Per informazioni sui parametri comuni per tutte le azioni, consulta [Parametri comuni](CommonParameters.md).

La richiesta accetta i seguenti dati in formato JSON.

 ** [AgentArn](#API_DescribeAgent_RequestSyntax) **   <a name="DataSync-DescribeAgent-request-AgentArn"></a>
Speciifica l'Amazon Resource Name (ARN) DataSync dell'agente su cui desideri informazioni.  
Tipo: String  
Limitazioni di lunghezza: lunghezza massima di 128.  
Modello: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`   
Obbligatorio: sì

## Sintassi della risposta
<a name="API_DescribeAgent_ResponseSyntax"></a>

```
{
   "AgentArn": "string",
   "CreationTime": number,
   "EndpointType": "string",
   "LastConnectionTime": number,
   "Name": "string",
   "Platform": { 
      "Version": "string"
   },
   "PrivateLinkConfig": { 
      "PrivateLinkEndpoint": "string",
      "SecurityGroupArns": [ "string" ],
      "SubnetArns": [ "string" ],
      "VpcEndpointId": "string"
   },
   "Status": "string"
}
```

## Elementi di risposta
<a name="API_DescribeAgent_ResponseElements"></a>

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

 ** [AgentArn](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-AgentArn"></a>
L'ARN dell'agente.  
Tipo: String  
Limitazioni di lunghezza: lunghezza massima di 128.  
Modello: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$` 

 ** [CreationTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-CreationTime"></a>
[L'ora in cui l'agente è stato attivato.](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html)  
Tipo: Timestamp

 ** [EndpointType](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-EndpointType"></a>
Il tipo di [endpoint di servizio](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html) a cui è connesso l'agente.  
Tipo: String  
Valori validi: `PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK` 

 ** [LastConnectionTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-LastConnectionTime"></a>
L'ultima volta che l'agente ha comunicato con il DataSync servizio.  
Tipo: Timestamp

 ** [Name](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Name"></a>
Il nome dell'agente.  
Tipo: String  
Limitazioni di lunghezza: lunghezza minima di 0. La lunghezza massima è 256 caratteri.  
Modello: `^[a-zA-Z0-9\s+=._:@/-]+$` 

 ** [Platform](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Platform"></a>
I dettagli relativi alla piattaforma sull'agente, ad esempio il numero di versione.  
Tipo: oggetto [Platform](API_Platform.md)

 ** [PrivateLinkConfig](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-PrivateLinkConfig"></a>
La configurazione di rete utilizzata dall'agente per la connessione a un endpoint del [servizio VPC](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc).  
Tipo: oggetto [PrivateLinkConfig](API_PrivateLinkConfig.md)

 ** [Status](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Status"></a>
Lo stato dell'agente.  
+ Se lo stato è`ONLINE`, l'agente è configurato correttamente e pronto per l'uso.
+ Se lo stato è`OFFLINE`, l'agente non è in contatto con l'agente DataSync da cinque minuti o più. Questo può succedere per diversi motivi. Per ulteriori informazioni, vedi [Cosa devo fare se il mio agente è offline?](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) 
Tipo: String  
Valori validi: `ONLINE | OFFLINE` 

## Errori
<a name="API_DescribeAgent_Errors"></a>

Per informazioni sugli errori comuni a tutte le operazioni, consultare [Errori comuni](CommonErrors.md).

 ** InternalException **   
Questa eccezione viene generata quando si verifica un errore nel AWS DataSync servizio.  
Codice di stato HTTP: 500

 ** InvalidRequestException **   
Questa eccezione viene generata quando il client invia una richiesta non valida.  
Codice di stato HTTP: 400

## Esempi
<a name="API_DescribeAgent_Examples"></a>

### Richiesta di esempio
<a name="API_DescribeAgent_Example_1"></a>

L'esempio seguente restituisce informazioni su un agente specificato in una richiesta.

```
{
  "AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0"
}
```

### Risposta di esempio
<a name="API_DescribeAgent_Example_2"></a>

Il seguente esempio di risposta descrive un agente che utilizza un endpoint di servizio pubblico.

```
{
    "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"
    }
}
```

## Vedi anche
<a name="API_DescribeAgent_SeeAlso"></a>

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
+  [AWS Interfaccia a riga di comando V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK per.NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK per C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK per Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK per Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK per V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK per Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK per PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK per Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK per Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeAgent) 