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

DescribeAgent

Restituisce i metadati relativi a un AWS DataSync agente, ad esempio il nome, il tipo di endpoint e lo stato.

Sintassi della richiesta

{ "AgentArn": "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.

AgentArn

Specifica il nome della risorsa Amazon (ARN) dell'DataSyncagente da descrivere.

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

Campo obbligatorio: sì

Sintassi della risposta

{ "AgentArn": "string", "CreationTime": number, "EndpointType": "string", "LastConnectionTime": number, "Name": "string", "PrivateLinkConfig": { "PrivateLinkEndpoint": "string", "SecurityGroupArns": [ "string" ], "SubnetArns": [ "string" ], "VpcEndpointId": "string" }, "Status": "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.

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

CreationTime

L'ora in cui l'agente è stato attivato (ovvero, creato nel tuo account).

Tipo: Timestamp

EndpointType

Il tipo di endpoint a cui l'agente è connesso. Se l'endpoint è un endpoint VPC, l'agente non è accessibile tramite Internet pubblico.

Tipo: String

Valori validi: PUBLIC | PRIVATE_LINK | FIPS

LastConnectionTime

L'ora in cui l'agente si è connesso l'ultima voltaDataSync.

Tipo: Timestamp

Name

Il nome dell'agente.

Tipo: String

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

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

PrivateLinkConfig

La sottorete e il gruppo di sicurezza DataSync utilizzati per accedere a un endpoint VPC.

Tipo: PrivateLinkConfig oggetto

Status

Lo stato dell'agente. Se lo stato è ONLINE, l'agente è configurato correttamente ed è disponibile per l'uso. Lo stato In esecuzione è il normale stato di esecuzione di un agente. Se lo stato è OFFLINE, la macchina virtuale dell'agente è spenta o l'agente è in uno stato non integro. Quando il problema che ha causato lo stato anomalo viene risolto, l'agente ritorna nello stato ONLINE.

Tipo: String

Valori validi: ONLINE | OFFLINE

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

Esempio

L'esempio seguente restituisce informazioni sull'agente specificato nella richiesta di esempio.

Richiesta di esempio

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

Esempio

Questo esempio illustra un utilizzo di. DescribeAgent

Risposta di esempio

{ "AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3", "CreationTime": "1532660733.39", "LastConnectionTime": "1532660733.39", "Name": "MyAgent", "Status": "ONLINE" }

Vedi anche

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