CreateAgent - AWS DataSync
AnforderungssyntaxAnfrageparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere 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.

CreateAgent

Aktiviert einen AWS DataSync Agenten, den Sie in Ihrer Speicherumgebung bereitgestellt haben. Der Aktivierungsprozess ordnet den Agenten Ihrem zuAWS-Konto.

Wenn Sie noch keinen Agenten bereitgestellt haben, finden Sie in den folgenden Themen weitere Informationen:

Anmerkung

Wenn Sie zwischen AWS Speicherdiensten wechseln, benötigen Sie keinen DataSync Agenten.

Anforderungssyntax

{
   "ActivationKey": "string",
   "AgentName": "string",
   "SecurityGroupArns": [ "string" ],
   "SubnetArns": [ "string" ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "VpcEndpointId": "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.

ActivationKey

Gibt den Aktivierungsschlüssel Ihres DataSync Agenten an. Wenn Sie keinen Aktivierungsschlüssel haben, finden Sie weitere Informationen unter Agenten aktivieren.

Typ: Zeichenfolge

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

Pattern: [A-Z0-9]{5}(-[A-Z0-9]{5}){4}

Erforderlich: Ja

AgentName

Gibt einen Namen für Ihren Agent an. Sie können diesen Namen in der DataSync Konsole sehen.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 256 Zeichen.

Pattern: ^[a-zA-Z0-9\s+=._:@/-]+$

Erforderlich: Nein

SecurityGroupArns

Gibt den Amazon-Ressourcennamen (ARN) der Sicherheitsgruppe an, die die Netzwerkschnittstellen Ihrer Aufgabe schützt, wenn Sie einen Virtual Private Cloud (VPC) -Endpunkt verwenden.

Typ: Zeichenfolge-Array

Array-Mitglieder: Feste Anzahl von 1 Element.

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

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$

Erforderlich: Nein

SubnetArns

Gibt den ARN des Subnetzes an, in dem Sie Ihre DataSync Aufgabe ausführen möchten, wenn Sie einen VPC-Endpunkt verwenden. Dies ist das Subnetz, in dem die Netzwerkschnittstellen für Ihre Übertragung DataSync erstellt und verwaltet werden.

Typ: Zeichenfolge-Array

Array-Mitglieder: Feste Anzahl von 1 Element.

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

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/.*$

Erforderlich: Nein

Tags

Gibt Bezeichnungen an, mit denen Sie Ihre AWS-Ressourcen kategorisieren, filtern und suchen können. Wir empfehlen, mindestens ein Tag für Ihren Agent zu erstellen.

Typ: Array von TagListEntry-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 50 Elemente.

Required: No

VpcEndpointId

Gibt die ID des VPC-Endpunkts an, mit dem sich Ihr Agent verbinden soll. Eine VPC-Endpunkt-ID sieht beispielsweise so vpce-01234d5aff67890e1 aus.

Wichtig

Der von Ihnen verwendete VPC-Endpunkt muss den DataSync Dienstnamen enthalten (z. B.com.amazonaws.us-east-2.datasync).

Typ: Zeichenfolge

Pattern: ^vpce-[0-9a-f]{17}$

Erforderlich: Nein

Antwortsyntax

{
   "AgentArn": "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 Agenten, den Sie gerade aktiviert haben. Verwenden Sie die ListAgentsOperation, um eine Liste der Agenten in Ihrem AWS-Konto und zurückzugebenAWS-Region.

Typ: Zeichenfolge

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

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}$

Fehler

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

InternalException

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

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

Beispiele

Beispielanforderung

Im folgenden Beispiel wird ein DataSync Agent aktiviert und mit Ihrem verknüpftAWS-Konto.

{
    "ActivationKey": "AAAAA-1AAAA-BB1CC-33333-EEEEE",
    "AgentName": "MyAgent",
    "Tags": [{
        "Key": "Job",
        "Value": "TransferJob-1"
    }]
}

Beispielantwort

Die Antwort gibt den ARN des aktivierten Agenten zurück.

{
    "AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3"
}

Weitere Informationen finden Sie unter:

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