DescribeAgent - AWS DataSync
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

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

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

Anforderungssyntax

{
   "AgentArn": "string"
}

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

AgentArn

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-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

Erforderlich: Ja

Antwortsyntax

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

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

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-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

CreationTime

Der Zeitpunkt, zu dem der Agent aktiviert wurde.

Typ: Zeitstempel

EndpointType

Der Typ des Dienstendpunkts, mit dem Ihr Agent verbunden ist.

Typ: Zeichenfolge

Zulässige Werte: PUBLIC | PRIVATE_LINK | FIPS

LastConnectionTime

Das letzte Mal, dass der Agent mit dem DataSync Service kommuniziert hat.

Typ: Zeitstempel

Name

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

Die plattformbezogenen Details zum Agenten, wie z. B. die Versionsnummer.

Typ: Platform Objekt

PrivateLinkConfig

Die Netzwerkkonfiguration, die der Agent verwendet, wenn er eine Verbindung zu einem VPC-Dienstendpunkt herstellt.

Typ: PrivateLinkConfig Objekt

Status

Der Status des Agenten.

  • Wenn der Status lautetONLINE, ist der Agent ordnungsgemäß konfiguriert und einsatzbereit.

  • Wenn der Status lautetOFFLINE, hat der Agent seit fünf Minuten oder länger keinen Kontakt DataSync mehr. Dies kann verschiedene Gründe haben. Weitere Informationen finden Sie unter Was mache ich, wenn mein Agent offline ist?

Typ: Zeichenfolge

Zulässige Werte: ONLINE | OFFLINE

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

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 Status Code: 400

Beispiele

Beispielanforderung

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

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:

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: