DescribeFileSystems

Mengembalikan deskripsi sistem file Amazon EFS tertentu jika sistem file CreationToken atau FileSystemId disediakan. Jika tidak, ia mengembalikan deskripsi semua sistem file yang dimiliki oleh pemanggil Akun AWS di titik Wilayah AWS akhir yang Anda panggil.

Saat mengambil semua deskripsi sistem file, Anda dapat menentukan MaxItems parameter secara opsional untuk membatasi jumlah deskripsi dalam respons. Nomor ini secara otomatis diatur ke 100. Jika lebih banyak deskripsi sistem file tetap ada, Amazon EFS mengembalikanNextMarker, token buram, dalam respons. Dalam hal ini, Anda harus mengirim permintaan berikutnya dengan parameter Marker permintaan yang disetel ke nilaiNextMarker.

Untuk mengambil daftar deskripsi sistem file Anda, operasi ini digunakan dalam proses iteratif, di mana DescribeFileSystems dipanggil pertama tanpa Marker dan kemudian operasi terus memanggilnya dengan Marker parameter diatur ke nilai NextMarker dari dari respon sebelumnya sampai respon memiliki tidak. NextMarker

Urutan sistem file yang dikembalikan dalam respons satu DescribeFileSystems panggilan dan urutan sistem file yang dikembalikan di seluruh respons iterasi multi-panggilan tidak ditentukan.

Operasi ini memerlukan izin utuk tindakan elasticfilesystem:DescribeFileSystems.

Minta Sintaks

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

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

CreationToken

(Opsional) Membatasi daftar ke sistem file dengan token penciptaan ini (String). Anda menentukan token pembuatan saat membuat sistem file Amazon EFS.

Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.

Pola: .+

FileSystemId

(Opsional) ID dari sistem file yang deskripsinya ingin Anda ambil (String).

Batasan Panjang: Panjang maksimum 128.

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

Marker

(Opsional) Token pagination buram dikembalikan dari DescribeFileSystems operasi sebelumnya (String). Jika ada, menentukan untuk melanjutkan daftar dari mana panggilan kembali telah ditinggalkan.

Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.

Pola: .+

MaxItems

(Opsional) Menentukan jumlah maksimum sistem file untuk kembali dalam respon (integer). Nomor ini secara otomatis diatur ke 100. Responsnya diberi paginasi pada 100 per halaman jika Anda memiliki lebih dari 100 sistem file.

Rentang yang Valid: Nilai minimum 1.

Isi Permintaan

Permintaan tidak memiliki isi permintaan.

Sintaks Respons

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

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

FileSystems

Array deskripsi sistem file.

Tipe: Array objek FileSystemDescription

Marker

Hadir jika disediakan oleh pemanggil dalam permintaan (String).

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.

Pola: .+

NextMarker

Hadir jika ada lebih banyak sistem file daripada dikembalikan dalam respons (String). Anda dapat menggunakan NextMarker dalam permintaan berikutnya untuk mengambil deskripsi.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 128.

Pola: .+

Kesalahan

BadRequest

Dikembalikan jika permintaan salah bentuk atau berisi kesalahan seperti nilai parameter yang tidak valid atau parameter wajib yang hilang.

Kode Status HTTP: 400

FileSystemNotFound

Dikembalikan jika FileSystemId nilai yang ditentukan tidak ada di pemohon. Akun AWS

Kode Status HTTP: 404

InternalServerError

Dikembalikan jika terjadi kesalahan di sisi server.

Kode Status HTTP: 500

Contoh-contoh

Ambil daftar 10 sistem file

Contoh berikut mengirimkan permintaan GET ke file-systems endpoint (elasticfilesystem.us-west-2.amazonaws.com/2015-02-01/file-systems). Permintaan menentukan parameter MaxItems query untuk membatasi jumlah deskripsi sistem file untuk 10.

Permintaan Sampel

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

Contoh Respons

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

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go.

• AWSSDK for Java V2

• AWSSDK untuk V3 JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3