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

ListServers

Muestra los servidores habilitados para el protocolo de transferencia de archivos que están asociados a su cuenta de AWS.

Sintaxis de la solicitud

{
   "MaxResults": number,
   "NextToken": "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 formato JSON.

MaxResults

Especifica el número de servidores que se devolverán como respuesta a la consulta ListServers.

Tipo: entero

Rango válido: valor mínimo de 1. Valor máximo de 1000.

Obligatorio: no

NextToken

Cuando se obtienen resultados adicionales del comando ListServers, se devuelve un parámetro NextToken en la salida. A continuación, puede pasar el parámetro NextToken en un comando posterior para seguir enumerando servidores adicionales.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 6144 caracteres.

Obligatorio: no

Sintaxis de la respuesta

{
   "NextToken": "string",
   "Servers": [ 
      { 
         "Arn": "string",
         "Domain": "string",
         "EndpointType": "string",
         "IdentityProviderType": "string",
         "LoggingRole": "string",
         "ServerId": "string",
         "State": "string",
         "UserCount": number
      }
   ]
}

Elementos de respuesta

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

El servicio devuelve los datos siguientes en formato JSON.

NextToken

Cuando pueda obtener resultados adicionales de la operación ListServers, se devolverá un parámetro NextToken en la salida. En el siguiente comando, puede pasar el parámetro NextToken para seguir enumerando servidores adicionales.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 6144 caracteres.

Servers

Conjunto de servidores que estaban en la lista.

Tipo: matriz de objetos ListedServer

Errores

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

InternalServiceError

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

Código de estado HTTP: 500

InvalidNextTokenException

El parámetro NextToken que se pasó no es válido.

Código de estado HTTP: 400

InvalidRequestException

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

Código de estado HTTP: 400

ServiceUnavailableException

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

Código de estado HTTP: 500

Ejemplos

Ejemplo

El siguiente ejemplo muestra los servidores que existen en su Cuenta de AWS.

Tenga en cuenta que los valores NextToken del ejemplo no son reales: están pensados para indicar cómo utilizar el parámetro.

Solicitud de muestra

{
   "MaxResults": 1,
   "NextToken": "token-from-previous-API-call"
}

Respuesta de ejemplo

{
   "NextToken": "another-token-to-continue-listing",
   "Servers": [
      {
         "Arn": "arn:aws:transfer:us-east-1:111112222222:server/s-01234567890abcdef",
         "Domain": "S3",
         "IdentityProviderType": "SERVICE_MANAGED",
         "EndpointType": "PUBLIC",
         "LoggingRole": "arn:aws:iam::111112222222:role/my-role",
         "ServerId": "s-01234567890abcdef",
         "State": "ONLINE",
         "UserCount": 3
      }
   ]
}

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: