CreateAgent - AWS DataSync

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à.

CreateAgent

Attiva un AWS DataSync agente che hai implementato nel tuo ambiente di storage. Il processo di attivazione associa l'agente al. Account AWS

Se non hai ancora implementato un agente, consulta i seguenti argomenti per saperne di più:

Nota

Se effettui il trasferimento tra servizi AWS di archiviazione, non hai bisogno di un DataSync agente.

Sintassi della richiesta

{ "ActivationKey": "string", "AgentName": "string", "SecurityGroupArns": [ "string" ], "SubnetArns": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcEndpointId": "string" }

Parametri della richiesta

Per informazioni sui parametri comuni a tutte le azioni, vedere Parametri comuni.

La richiesta accetta i seguenti dati in formato JSON.

ActivationKey

Specifica la chiave di attivazione del tuo DataSync agente. Se non disponi di una chiave di attivazione, consulta Attiva il tuo agente.

Tipo: String

Limitazioni di lunghezza: lunghezza massima di 29.

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

Campo obbligatorio: sì

AgentName

Specifica il nome dell'agente. Puoi vedere questo nome nella DataSync console.

Tipo: String

Limitazioni di lunghezza: lunghezza minima di 1. La lunghezza massima è 256 caratteri.

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

Required: No

SecurityGroupArns

Specifica l'Amazon Resource Name (ARN) del gruppo di sicurezza che protegge le interfacce di rete dell'attività quando si utilizza un endpoint cloud privato virtuale (VPC).

Tipo: matrice di stringhe

Membri dell'array: numero minimo di 1 elemento.

Limitazioni di lunghezza: lunghezza massima di 128.

Modello: ^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]+$

Required: No

SubnetArns

Specifica l'ARN della sottorete in cui si desidera eseguire l'DataSyncattività quando si utilizza un endpoint VPC. Questa è la sottorete in cui DataSync crea e gestisce le interfacce di rete per il trasferimento.

Tipo: matrice di stringhe

Membri dell'array: numero minimo di 1 elemento.

Limitazioni di lunghezza: lunghezza massima di 128.

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

Required: No

Tags

Specifica le etichette che consentono di classificare, filtrare e cercare le risorse AWS. È consigliabile creare almeno un tag per l'agente.

Tipo: matrice di oggetti TagListEntry

Membri dell'array: numero minimo di 0 elementi. Numero massimo di 50 item.

Required: No

VpcEndpointId

Specifica l'ID dell'endpoint VPC a cui si desidera connettere l'agente. Ad esempio, si desidera connettere un endpoint VPC. vpce-01234d5aff67890e1

Importante

L'endpoint VPC utilizzato deve includere il nome del DataSync servizio (ad esempio,com.amazonaws.us-east-2.datasync).

Tipo: stringa

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

Required: No

Sintassi della risposta

{ "AgentArn": "string" }

Elementi di risposta

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

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

AgentArn

L'ARN dell'agente che hai appena attivato. Usa l'ListAgentsoperazione per restituire un elenco di agenti nel tuo Account AWS eRegione AWS.

Tipo: String

Limitazioni di lunghezza: lunghezza massima di 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}$

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

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

Richiesta di esempio

L'esempio seguente attiva un DataSync agente e lo associa al tuo. Account AWS

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

Risposta di esempio

La risposta restituisce l'ARN dell'agente attivato.

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

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli SDK AWS specifici della lingua, consulta quanto segue: