DescribeServer - AWS Transfer Family
Sintaxis de la solicitudParámetros de la solicitudSintaxis de la respuestaElementos de respuestaErroresEjemplosVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeServer

Describe un servidor habilitado para el protocolo de transferencia de archivos que se especifica pasando el parámetro ServerId.

La respuesta contiene una descripción de las propiedades de un servidor. Cuando se establece EndpointType enVPC, la respuesta contendrá elEndpointDetails.

Sintaxis de la solicitud

{
   "ServerId": "string"
}

Parámetros de la solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

La solicitud acepta los siguientes datos en JSON formato.

ServerId

Identificador único asignado por el sistema para un servidor.

Tipo: cadena

Limitaciones de longitud: longitud fija de 19.

Patrón: s-([0-9a-f]{17})

Obligatorio: sí

Sintaxis de la respuesta

{
   "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"
            }
         ]
      }
   }
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta de HTTP 200.

El servicio devuelve los siguientes datos en JSON formato.

Server

Una matriz que contiene las propiedades de un servidor con las ServerID que especificó.

Tipo: objeto DescribedServer

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

InternalServiceError

Esta excepción se produce cuando se produce un error en el AWS Transfer Family servicio.

HTTPCódigo de estado: 500

InvalidRequestException

Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.

HTTPCódigo de estado: 400

ResourceNotFoundException

Esta excepción se produce cuando el servicio AWS Transfer Family no encuentra un recurso.

HTTPCódigo de estado: 400

ServiceUnavailableException

La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.

HTTPCódigo de estado: 500

Ejemplos

Ejemplo

En el siguiente ejemplo, se devuelven las propiedades asignadas a un servidor.

Solicitud de muestra


{
   "ServerId": "s-01234567890abcdef"
}

Ejemplo

Este ejemplo ilustra un uso de DescribeServer.

Respuesta de ejemplo


{
    "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
    }
}

Véase también

Para obtener más información sobre su uso API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente: