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à.
DescribeServer
Descrive un server abilitato al protocollo di trasferimento file specificato passando il ServerId parametro.
La risposta contiene una descrizione delle proprietà di un server. Quando si imposta EndpointType suVPC, la risposta conterrà ilEndpointDetails.
Sintassi della richiesta
{
"ServerId": "string"
}Parametri della richiesta
Per informazioni sui parametri comuni per tutte le azioni, consulta Parametri comuni.
La richiesta accetta i seguenti dati nel JSON formato.
- ServerId
-
Un identificatore univoco assegnato dal sistema per un server.
Tipo: stringa
Vincoli di lunghezza: lunghezza fissa di 19.
Modello:
s-([0-9a-f]{17})Campo obbligatorio: sì
Sintassi della risposta
{
"Server": {
"Arn": "string",
"As2ServiceManagedEgressIpAddresses": [ "string" ],
"Certificate": "string",
"Domain": "string",
"EndpointDetails": {
"AddressAllocationIds": [ "string" ],
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VpcEndpointId": "string",
"VpcId": "string"
},
"EndpointType": "string",
"HostKeyFingerprint": "string",
"IdentityProviderDetails": {
"DirectoryId": "string",
"Function": "string",
"InvocationRole": "string",
"SftpAuthenticationMethods": "string",
"Url": "string"
},
"IdentityProviderType": "string",
"LoggingRole": "string",
"PostAuthenticationLoginBanner": "string",
"PreAuthenticationLoginBanner": "string",
"ProtocolDetails": {
"As2Transports": [ "string" ],
"PassiveIp": "string",
"SetStatOption": "string",
"TlsSessionResumptionMode": "string"
},
"Protocols": [ "string" ],
"S3StorageOptions": {
"DirectoryListingOptimization": "string"
},
"SecurityPolicyName": "string",
"ServerId": "string",
"State": "string",
"StructuredLogDestinations": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UserCount": number,
"WorkflowDetails": {
"OnPartialUpload": [
{
"ExecutionRole": "string",
"WorkflowId": "string"
}
],
"OnUpload": [
{
"ExecutionRole": "string",
"WorkflowId": "string"
}
]
}
}
}Elementi di risposta
Se l'azione ha esito positivo, il servizio restituisce una risposta di HTTP 200.
I seguenti dati vengono restituiti in JSON formato dal servizio.
- Server
-
Un array contenente le proprietà di un server con il valore specificato dall'
ServerIDutente.Tipo: oggetto DescribedServer
Errori
Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.
- InternalServiceError
-
Questa eccezione viene generata quando si verifica un errore nel AWS Transfer Family servizio.
HTTPCodice di stato: 500
- InvalidRequestException
-
Questa eccezione viene generata quando il client invia una richiesta non valida.
HTTPCodice di stato: 400
- ResourceNotFoundException
-
Questa eccezione viene generata quando una risorsa non viene trovata dal servizio AWS Transfer Family.
HTTPCodice di stato: 400
- ServiceUnavailableException
-
La richiesta non è riuscita perché il servizio AWS Transfer Family non è disponibile.
HTTPCodice di stato: 500
Esempi
Esempio
L'esempio seguente restituisce le proprietà assegnate a un server.
Richiesta di esempio
{
"ServerId": "s-01234567890abcdef"
}Esempio
Questo esempio illustra un utilizzo di. DescribeServer
Risposta di esempio
{
"Server": {
"Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef",
"EndpointDetails": {
"AddressAllocationIds": [
"eipalloc-01a2eabe3c04d5678",
"eipalloc-102345be"
],
"SubnetIds": [
"subnet-047eaa7f0187a7cde",
"subnet-0a2d0f474daffde18"
],
"VpcEndpointId": "vpce-03fe0080e7cb008b8",
"VpcId": "vpc-09047a51f1c8e1634"
},
"EndpointType": "VPC",
"HostKeyFingerprint": "your host key,
"IdentityProviderType": "SERVICE_MANAGED",
"ServerId": "s-01234567890abcdef",
"State": "ONLINE",
"Tags": [],
"UserCount": 0
}
}Vedi anche
Per ulteriori informazioni sull'utilizzo di questo API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
