

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

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

Gibt Informationen über einen AWS DataSync Agenten zurück, z. B. seinen Namen, seinen Dienstendpunkttyp und seinen Status.

## Anforderungssyntax
<a name="API_DescribeAgent_RequestSyntax"></a>

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

## Anforderungsparameter
<a name="API_DescribeAgent_RequestParameters"></a>

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [AgentArn](#API_DescribeAgent_RequestSyntax) **   <a name="DataSync-DescribeAgent-request-AgentArn"></a>
Gibt den Amazon-Ressourcennamen (ARN) des DataSync Agenten an, über den Sie Informationen benötigen.  
Typ: Zeichenfolge  
Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.  
Pattern: `^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}$`   
Erforderlich: Ja

## Antwortsyntax
<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"
}
```

## Antwortelemente
<a name="API_DescribeAgent_ResponseElements"></a>

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

 ** [AgentArn](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-AgentArn"></a>
Der ARN des Kundendienstmitarbeiters.  
Typ: Zeichenfolge  
Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.  
Pattern: `^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>
Der Zeitpunkt, zu dem der Agent [aktiviert](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html) wurde.  
Typ: Zeitstempel

 ** [EndpointType](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-EndpointType"></a>
Der Typ des [Dienstendpunkts](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html), mit dem Ihr Agent verbunden ist.  
Typ: Zeichenfolge  
Zulässige Werte: `PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK` 

 ** [LastConnectionTime](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-LastConnectionTime"></a>
Das letzte Mal, dass der Agent mit dem DataSync Service kommuniziert hat.  
Typ: Zeitstempel

 ** [Name](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Name"></a>
Der Name des Agenten.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 256 Zeichen.  
Pattern: `^[a-zA-Z0-9\s+=._:@/-]+$` 

 ** [Platform](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Platform"></a>
Die plattformbezogenen Details über den Agenten, wie z. B. die Versionsnummer.  
Typ: [Platform](API_Platform.md) Objekt

 ** [PrivateLinkConfig](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-PrivateLinkConfig"></a>
Die Netzwerkkonfiguration, die der Agent verwendet, wenn er eine Verbindung zu einem [VPC-Dienstendpunkt](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc) herstellt.  
Typ: [PrivateLinkConfig](API_PrivateLinkConfig.md) Objekt

 ** [Status](#API_DescribeAgent_ResponseSyntax) **   <a name="DataSync-DescribeAgent-response-Status"></a>
Der Status des Agenten.  
+ Wenn der Status lautet`ONLINE`, ist der Agent ordnungsgemäß konfiguriert und einsatzbereit.
+ Wenn der Status lautet`OFFLINE`, hat der Agent seit mindestens fünf DataSync Minuten keinen Kontakt mehr zu Ihnen aufgenommen. Dies kann verschiedene Gründe haben. Weitere Informationen finden Sie unter [Was mache ich, wenn mein Agent offline ist?](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) 
Typ: Zeichenfolge  
Zulässige Werte: `ONLINE | OFFLINE` 

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

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InternalException **   
Diese Ausnahme wird ausgelöst, wenn im AWS DataSync Dienst ein Fehler auftritt.  
HTTP Status Code: 500

 ** InvalidRequestException **   
Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.  
HTTP-Statuscode: 400

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

### Beispielanforderung
<a name="API_DescribeAgent_Example_1"></a>

Das folgende Beispiel gibt Informationen über einen in einer Anfrage angegebenen Agenten zurück.

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

### Beispielantwort
<a name="API_DescribeAgent_Example_2"></a>

Die folgende Beispielantwort beschreibt einen Agenten, der einen öffentlichen Dienstendpunkt verwendet.

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

## Weitere Informationen finden Sie unter:
<a name="API_DescribeAgent_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS Befehlszeilenschnittstelle V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeAgent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeAgent) 