ListAgents - AWS DataSync
AnforderungssyntaxAnfrageparameterAntwortsyntaxAntwortelementeFehlerWeitere 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.

ListAgents

Gibt eine Liste vonAWS DataSync Agenten zurück, die zu einemAWS-Konto in der AnfrageAWS-Region angegebenen Verzeichnis gehören.

Mit der Paginierung können Sie die Anzahl der Agenten reduzieren, die in einer Antwort zurückgegeben werden. Wenn Sie in einer Antwort eine gekürzte Liste von Agenten erhalten, enthält die Antwort eine Markierung, die Sie in Ihrer nächsten Anfrage angeben können, um die nächste Seite mit Agenten abzurufen.

ListAgentsist Eventually Consistent. Das bedeutet, dass das Ergebnis der Ausführung des Vorgangs möglicherweise nicht widerspiegelt, dass Sie gerade einen Agenten erstellt oder gelöscht haben. Wenn Sie beispielsweise einen Agenten mit erstellen CreateAgentund ihn dann sofort ausführenListAgents, wird dieser Agent möglicherweise nicht sofort in der Liste angezeigt. In solchen Situationen können Sie jederzeit überprüfen, ob ein Agent erstellt (oder gelöscht) wurde, indem Sie DescribeAgent.

Anforderungssyntax

{
   "MaxResults": number,
   "NextToken": "string"
}

Anfrageparameter

Informationen zu den Parametern, die allen Aktionen gemeinsam sind, finden Sie unter Allgemeine Parameter.

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

MaxResults

Gibt die maximale Anzahl vonDataSync Agents an, die in einer Antwort aufgeführt werden. Standardmäßig zeigt eine Antwort maximal 100 Agenten.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 0. Maximalwert 100.

Required: No

NextToken

Gibt eine undurchsichtige Zeichenfolge an, die die Position angibt, an der die nächste Ergebnisliste in der Antwort beginnen soll.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge von 65535.

Pattern: [a-zA-Z0-9=_-]+

Erforderlich: Nein

Antwortsyntax

{
   "Agents": [ 
      { 
         "AgentArn": "string",
         "Name": "string",
         "Status": "string"
      }
   ],
   "NextToken": "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.

Agents

Eine Liste derDataSync AgentenAWS-Konto in Ihrem in der AnfrageAWS-Region angegebenen. Die Liste wird nach Amazon-Ressourcennamen (ARNs) der -Ressourcen sortiert.

Typ: Array von AgentListEntry-Objekten

NextToken

Die undurchsichtige Zeichenfolge, die die Position angibt, an der die nächste Ergebnisliste in der Antwort beginnen soll.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge von 65535.

Pattern: [a-zA-Z0-9=_-]+

Fehler

Hinweise zu den Fehlern, die allen Aktionen gemeinsam sind, finden Sie unterHäufige Fehler.

InternalException

Diese Ausnahme wird ausgelöst, wenn ein Fehler imAWS DataSync Dienst auftritt.

HTTP Status Code: 500

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine fehlerhafte Anfrage sendet.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: