DescribeFileSystems - Amazon Elastic File System

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.

DescribeFileSystems

Devuelve la descripción de un sistema de archivos de Amazon EFS específico si se proporciona CreationToken o FileSystemId del sistema de archivos. De lo contrario, devuelve las descripciones de todos los sistemas de archivos que sean propiedad de la Cuenta de AWS del intermediario en la Región de AWS del punto de conexión al que está llamando.

Al recuperar todas las descripciones de los sistemas de archivos, si lo desea, puede especificar el parámetro MaxItems para limitar el número de descripciones en una respuesta. Este número se establece automáticamente en 100. Si quedan más descripciones de sistemas de archivos, Amazon EFS devuelve un NextMarker, un token opaco, en la respuesta. En este caso, debe enviar una solicitud posterior con el parámetro de solicitud Marker establecido en el valor de NextMarker.

Para recuperar una lista de las descripciones del sistema de archivos, esta operación se utiliza en un proceso iterativo, en el que DescribeFileSystems se llama primero sin el Marker y, a continuación, la operación continúa llamándola con el parámetro Marker establecido en el valor de NextMarker de la respuesta anterior hasta que la respuesta no tenga ningún NextMarker.

El orden de los sistemas de archivos devueltos en la respuesta a una llamada a DescribeFileSystems y el orden de los sistemas de archivos devueltos en las respuestas de una iteración de varias llamadas no están especificados.

Esta operación necesita permisos para la acción elasticfilesystem:DescribeFileSystems.

Sintaxis de la solicitud

GET /2015-02-01/file-systems?CreationToken=CreationToken&FileSystemId=FileSystemId&Marker=Marker&MaxItems=MaxItems HTTP/1.1

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

CreationToken

(Opcional) Restringe la lista al sistema de archivos con este identificador de creación (cadena). Al crear un sistema de archivos de Amazon EFS, se especifica un token de creación.

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

Patrón: .+

FileSystemId

(Opcional) ID del sistema de archivos cuya descripción desea recuperar (cadena).

Limitaciones de longitud: longitud máxima de 128 caracteres.

Patrón: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$

Marker

(Opcional) Un token de paginación opaco devuelto por una operación DescribeFileSystems anterior (cadena). Si está presente, especifica continuar la lista desde donde terminó la llamada de devolución.

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

Patrón: .+

MaxItems

(Opcional) Especifica el número máximo de sistemas de archivos que se devuelven en una respuesta (integer). Este número se establece automáticamente en 100. La respuesta se pagina a 100 por página si tiene más de 100 sistemas de archivos.

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

Cuerpo de la solicitud

La solicitud no tiene un cuerpo de la solicitud.

Sintaxis de la respuesta

HTTP/1.1 200 Content-type: application/json { "FileSystems": [ { "AvailabilityZoneId": "string", "AvailabilityZoneName": "string", "CreationTime": number, "CreationToken": "string", "Encrypted": boolean, "FileSystemArn": "string", "FileSystemId": "string", "FileSystemProtection": { "ReplicationOverwriteProtection": "string" }, "KmsKeyId": "string", "LifeCycleState": "string", "Name": "string", "NumberOfMountTargets": number, "OwnerId": "string", "PerformanceMode": "string", "ProvisionedThroughputInMibps": number, "SizeInBytes": { "Timestamp": number, "Value": number, "ValueInArchive": number, "ValueInIA": number, "ValueInStandard": number }, "Tags": [ { "Key": "string", "Value": "string" } ], "ThroughputMode": "string" } ], "Marker": "string", "NextMarker": "string" }

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.

FileSystems

Conjunto de descripciones de sistemas de archivos.

Tipo: matriz de objetos FileSystemDescription

Marker

Está presente si el intermediario lo proporciona en la solicitud (cadena).

Tipo: string

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

Patrón: .+

NextMarker

Está presente si hay más sistemas de archivos de los devueltos en la respuesta (cadena). Se puede utilizar NextMarker en la solicitud subsiguiente para obtener las descripciones.

Tipo: string

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

Patrón: .+

Errores

BadRequest

Se devuelve si la solicitud tiene un formato incorrecto o contiene un error, como un valor de parámetro no válido, o falta un parámetro obligatorio.

Código de estado HTTP: 400

FileSystemNotFound

Se devuelve si el valor FileSystemId especificado no existe en el Cuenta de AWS del solicitante.

Código de estado HTTP: 404

InternalServerError

Se devuelve si se ha producido un error en el servidor.

Código de estado HTTP: 500

Ejemplos

Recupere una lista de 10 sistemas de archivos

El siguiente ejemplo envía una solicitud GET al punto de conexión file-systems (elasticfilesystem.us-west-2.amazonaws.com/2015-02-01/file-systems). La solicitud especifica un parámetro de consulta MaxItems para limitar el número de descripciones del sistema de archivos a 10.

Solicitud de muestra

GET /2015-02-01/file-systems?MaxItems=10 HTTP/1.1 Host: elasticfilesystem.us-west-2.amazonaws.com x-amz-date: 20140622T191208Z Authorization: <...>

Respuesta de ejemplo

HTTP/1.1 200 OK x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef Content-Type: application/json Content-Length: 499 { "FileSystems":[ { "OwnerId":"251839141158", "CreationToken":"MyFileSystem1", "FileSystemId":"fs-01234567", "PerformanceMode" : "generalPurpose", "CreationTime":"1403301078", "LifeCycleState":"created", "Name":"my first file system", "NumberOfMountTargets":1, "SizeInBytes":{ "Timestamp": 1403301078, "Value": 29313618372, "ValueInArchive": 201156, "ValueInIA": 675432, "ValueInStandard": 29312741784 } } ] }

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: